« blib/lib/Paws/SSMIncidents/UpdateReplicationSetOutput.pm
↑ Summary
blib/lib/Paws/SSMIncidents/UpdateResponsePlanOutput.pm »
| 1 | |||
| 2 | package Paws::SSMIncidents::UpdateResponsePlan; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'ArrayRef[Paws::SSMIncidents::Action]', traits => ['NameInRequest'], request_name => 'actions'); | ||
| 5 | has Arn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'arn', required => 1); | ||
| 6 | has ChatChannel => (is => 'ro', isa => 'Paws::SSMIncidents::ChatChannel', traits => ['NameInRequest'], request_name => 'chatChannel'); | ||
| 7 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 8 | has DisplayName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'displayName'); | ||
| 9 | has Engagements => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'engagements'); | ||
| 10 | has IncidentTemplateDedupeString => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'incidentTemplateDedupeString'); | ||
| 11 | has IncidentTemplateImpact => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'incidentTemplateImpact'); | ||
| 12 | has IncidentTemplateNotificationTargets => (is => 'ro', isa => 'ArrayRef[Paws::SSMIncidents::NotificationTargetItem]', traits => ['NameInRequest'], request_name => 'incidentTemplateNotificationTargets'); | ||
| 13 | has IncidentTemplateSummary => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'incidentTemplateSummary'); | ||
| 14 | has IncidentTemplateTitle => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'incidentTemplateTitle'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateResponsePlan'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/updateResponsePlan'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMIncidents::UpdateResponsePlanOutput'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::SSMIncidents::UpdateResponsePlan - Arguments for method UpdateResponsePlan on L<Paws::SSMIncidents> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method UpdateResponsePlan on the | ||
| 33 | L<AWS Systems Manager Incident Manager|Paws::SSMIncidents> service. Use the attributes of this class | ||
| 34 | as arguments to method UpdateResponsePlan. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateResponsePlan. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $ssm-incidents = Paws->service('SSMIncidents'); | ||
| 41 | my $UpdateResponsePlanOutput = $ssm -incidents->UpdateResponsePlan( | ||
| 42 | Arn => 'MyArn', | ||
| 43 | Actions => [ | ||
| 44 | { | ||
| 45 | SsmAutomation => { | ||
| 46 | DocumentName => 'MySsmAutomationDocumentNameString', | ||
| 47 | RoleArn => 'MyRoleArn', # max: 1000 | ||
| 48 | DocumentVersion => | ||
| 49 | 'MySsmAutomationDocumentVersionString', # max: 128; OPTIONAL | ||
| 50 | Parameters => { | ||
| 51 | 'MySsmParametersKeyString' => [ | ||
| 52 | 'MySsmParameterValuesMemberString', ... # max: 512 | ||
| 53 | ], # key: min: 1, max: 50, value: max: 100 | ||
| 54 | }, # min: 1, max: 200; OPTIONAL | ||
| 55 | TargetAccount => 'RESPONSE_PLAN_OWNER_ACCOUNT' | ||
| 56 | , # values: RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT; OPTIONAL | ||
| 57 | }, # OPTIONAL | ||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | ChatChannel => { | ||
| 62 | ChatbotSns => [ | ||
| 63 | 'MySnsArn', ... # max: 1000 | ||
| 64 | ], # min: 1, max: 5; OPTIONAL | ||
| 65 | Empty => { | ||
| 66 | |||
| 67 | }, # OPTIONAL | ||
| 68 | }, # OPTIONAL | ||
| 69 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 70 | DisplayName => 'MyResponsePlanDisplayName', # OPTIONAL | ||
| 71 | Engagements => [ | ||
| 72 | 'MySsmContactsArn', ... # max: 2048 | ||
| 73 | ], # OPTIONAL | ||
| 74 | IncidentTemplateDedupeString => 'MyDedupeString', # OPTIONAL | ||
| 75 | IncidentTemplateImpact => 1, # OPTIONAL | ||
| 76 | IncidentTemplateNotificationTargets => [ | ||
| 77 | { | ||
| 78 | SnsTopicArn => 'MyArn', # max: 1000 | ||
| 79 | }, | ||
| 80 | ... | ||
| 81 | ], # OPTIONAL | ||
| 82 | IncidentTemplateSummary => 'MyIncidentSummary', # OPTIONAL | ||
| 83 | IncidentTemplateTitle => 'MyIncidentTitle', # OPTIONAL | ||
| 84 | ); | ||
| 85 | |||
| 86 | 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. | ||
| 87 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents/UpdateResponsePlan> | ||
| 88 | |||
| 89 | =head1 ATTRIBUTES | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Actions => ArrayRef[L<Paws::SSMIncidents::Action>] | ||
| 93 | |||
| 94 | The actions that this response plan takes at the beginning of an | ||
| 95 | incident. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> Arn => Str | ||
| 100 | |||
| 101 | The Amazon Resource Name (ARN) of the response plan. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 ChatChannel => L<Paws::SSMIncidents::ChatChannel> | ||
| 106 | |||
| 107 | The AWS Chatbot chat channel used for collaboration during an incident. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 ClientToken => Str | ||
| 112 | |||
| 113 | A token ensuring that the action is called only once with the specified | ||
| 114 | details. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 DisplayName => Str | ||
| 119 | |||
| 120 | The long format name of the response plan. Can't contain spaces. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 Engagements => ArrayRef[Str|Undef] | ||
| 125 | |||
| 126 | The contacts and escalation plans that Incident Manager engages at the | ||
| 127 | start of the incident. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 IncidentTemplateDedupeString => Str | ||
| 132 | |||
| 133 | Used to create only one incident record for an incident. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 IncidentTemplateImpact => Int | ||
| 138 | |||
| 139 | Defines the impact to the customers. Providing an impact overwrites the | ||
| 140 | impact provided by a response plan. | ||
| 141 | |||
| 142 | B<Possible impacts:> | ||
| 143 | |||
| 144 | =over | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | C<5> - Severe impact | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | C<4> - High impact | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | C<3> - Medium impact | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | C<2> - Low impact | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | C<1> - No impact | ||
| 165 | |||
| 166 | =back | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 IncidentTemplateNotificationTargets => ArrayRef[L<Paws::SSMIncidents::NotificationTargetItem>] | ||
| 172 | |||
| 173 | The SNS targets that AWS Chatbot uses to notify the chat channels and | ||
| 174 | perform actions on the incident record. | ||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head2 IncidentTemplateSummary => Str | ||
| 179 | |||
| 180 | A brief summary of the incident. This typically contains what has | ||
| 181 | happened, what's currently happening, and next steps. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 IncidentTemplateTitle => Str | ||
| 186 | |||
| 187 | The short format name of the incident. Can't contain spaces. | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | =head1 SEE ALSO | ||
| 193 | |||
| 194 | This class forms part of L<Paws>, documenting arguments for method UpdateResponsePlan in L<Paws::SSMIncidents> | ||
| 195 | |||
| 196 | =head1 BUGS and CONTRIBUTIONS | ||
| 197 | |||
| 198 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 199 | |||
| 200 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 201 | |||
| 202 | =cut | ||
| 203 |