« blib/lib/Paws/SSMIncidents/SsmParameters.pm
↑ Summary
blib/lib/Paws/SSMIncidents/StartIncidentOutput.pm »
| 1 | |||
| 2 | package Paws::SSMIncidents::StartIncident; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 5 | has Impact => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'impact'); | ||
| 6 | has RelatedItems => (is => 'ro', isa => 'ArrayRef[Paws::SSMIncidents::RelatedItem]', traits => ['NameInRequest'], request_name => 'relatedItems'); | ||
| 7 | has ResponsePlanArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'responsePlanArn', required => 1); | ||
| 8 | has Title => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'title'); | ||
| 9 | has TriggerDetails => (is => 'ro', isa => 'Paws::SSMIncidents::TriggerDetails', traits => ['NameInRequest'], request_name => 'triggerDetails'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartIncident'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/startIncident'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMIncidents::StartIncidentOutput'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SSMIncidents::StartIncident - Arguments for method StartIncident on L<Paws::SSMIncidents> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method StartIncident on the | ||
| 28 | L<AWS Systems Manager Incident Manager|Paws::SSMIncidents> service. Use the attributes of this class | ||
| 29 | as arguments to method StartIncident. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartIncident. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ssm-incidents = Paws->service('SSMIncidents'); | ||
| 36 | my $StartIncidentOutput = $ssm -incidents->StartIncident( | ||
| 37 | ResponsePlanArn => 'MyArn', | ||
| 38 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 39 | Impact => 1, # OPTIONAL | ||
| 40 | RelatedItems => [ | ||
| 41 | { | ||
| 42 | Identifier => { | ||
| 43 | Type => 'ANALYSIS' | ||
| 44 | , # values: ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER | ||
| 45 | Value => { | ||
| 46 | Arn => 'MyArn', # max: 1000 | ||
| 47 | MetricDefinition => 'MyMetricDefinition', # max: 4000; OPTIONAL | ||
| 48 | Url => 'MyUrl', # max: 1000; OPTIONAL | ||
| 49 | }, | ||
| 50 | |||
| 51 | }, | ||
| 52 | Title => 'MyRelatedItemTitleString', # max: 200; OPTIONAL | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | Title => 'MyIncidentTitle', # OPTIONAL | ||
| 57 | TriggerDetails => { | ||
| 58 | Source => 'MyIncidentSource', # max: 50 | ||
| 59 | Timestamp => '1970-01-01T01:00:00', | ||
| 60 | RawData => 'MyRawData', # max: 4000; OPTIONAL | ||
| 61 | TriggerArn => 'MyArn', # max: 1000 | ||
| 62 | }, # OPTIONAL | ||
| 63 | ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $IncidentRecordArn = $StartIncidentOutput->IncidentRecordArn; | ||
| 67 | |||
| 68 | # Returns a L<Paws::SSMIncidents::StartIncidentOutput> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents/StartIncident> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ClientToken => Str | ||
| 77 | |||
| 78 | A token ensuring that the action is called only once with the specified | ||
| 79 | details. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Impact => Int | ||
| 84 | |||
| 85 | Defines the impact to the customers. Providing an impact overwrites the | ||
| 86 | impact provided by a response plan. | ||
| 87 | |||
| 88 | B<Possible impacts:> | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<1> - Critical impact, this typically relates to full application | ||
| 95 | failure that impacts many to all customers. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<2> - High impact, partial application failure with impact to many | ||
| 100 | customers. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<3> - Medium impact, the application is providing reduced service to | ||
| 105 | customers. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<4> - Low impact, customer might aren't impacted by the problem yet. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<5> - No impact, customers aren't currently impacted but urgent action | ||
| 114 | is needed to avoid impact. | ||
| 115 | |||
| 116 | =back | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 RelatedItems => ArrayRef[L<Paws::SSMIncidents::RelatedItem>] | ||
| 122 | |||
| 123 | Add related items to the incident for other responders to use. Related | ||
| 124 | items are AWS resources, external links, or files uploaded to an S3 | ||
| 125 | bucket. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 B<REQUIRED> ResponsePlanArn => Str | ||
| 130 | |||
| 131 | The Amazon Resource Name (ARN) of the response plan that pre-defines | ||
| 132 | summary, chat channels, SNS topics, runbooks, title, and impact of the | ||
| 133 | incident. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 Title => Str | ||
| 138 | |||
| 139 | Provide a title for the incident. Providing a title overwrites the | ||
| 140 | title provided by the response plan. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 TriggerDetails => L<Paws::SSMIncidents::TriggerDetails> | ||
| 145 | |||
| 146 | Details of what created the incident record in Incident Manager. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head1 SEE ALSO | ||
| 152 | |||
| 153 | This class forms part of L<Paws>, documenting arguments for method StartIncident in L<Paws::SSMIncidents> | ||
| 154 | |||
| 155 | =head1 BUGS and CONTRIBUTIONS | ||
| 156 | |||
| 157 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 158 | |||
| 159 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 160 | |||
| 161 | =cut | ||
| 162 |