blib/lib/Paws/SSM/UpdateOpsItem.pm untested

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSM::UpdateOpsItem;
3 use Moose;
4 has ActualEndTime => (is => 'ro', isa => 'Str');
5 has ActualStartTime => (is => 'ro', isa => 'Str');
6 has Category => (is => 'ro', isa => 'Str');
7 has Description => (is => 'ro', isa => 'Str');
8 has Notifications => (is => 'ro', isa => 'ArrayRef[Paws::SSM::OpsItemNotification]');
9 has OperationalData => (is => 'ro', isa => 'Paws::SSM::OpsItemOperationalData');
10 has OperationalDataToDelete => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
11 has OpsItemId => (is => 'ro', isa => 'Str', required => 1);
12 has PlannedEndTime => (is => 'ro', isa => 'Str');
13 has PlannedStartTime => (is => 'ro', isa => 'Str');
14 has Priority => (is => 'ro', isa => 'Int');
15 has RelatedOpsItems => (is => 'ro', isa => 'ArrayRef[Paws::SSM::RelatedOpsItem]');
16 has Severity => (is => 'ro', isa => 'Str');
17 has Status => (is => 'ro', isa => 'Str');
18 has Title => (is => 'ro', isa => 'Str');
19  
20 use MooseX::ClassAttribute;
21  
22 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateOpsItem');
23 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::UpdateOpsItemResponse');
24 class_has _result_key => (isa => 'Str', is => 'ro');
25 1;
26  
27 ### main pod documentation begin ###
28  
29 =head1 NAME
30  
31 Paws::SSM::UpdateOpsItem - Arguments for method UpdateOpsItem on L<Paws::SSM>
32  
33 =head1 DESCRIPTION
34  
35 This class represents the parameters used for calling the method UpdateOpsItem on the
36 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
37 as arguments to method UpdateOpsItem.
38  
39 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateOpsItem.
40  
41 =head1 SYNOPSIS
42  
43 my $ssm = Paws->service('SSM');
44 my $UpdateOpsItemResponse = $ssm->UpdateOpsItem(
45 OpsItemId => 'MyOpsItemId',
46 ActualEndTime => '1970-01-01T01:00:00', # OPTIONAL
47 ActualStartTime => '1970-01-01T01:00:00', # OPTIONAL
48 Category => 'MyOpsItemCategory', # OPTIONAL
49 Description => 'MyOpsItemDescription', # OPTIONAL
50 Notifications => [
51 {
52 Arn => 'MyString', # OPTIONAL
53 },
54 ...
55 ], # OPTIONAL
56 OperationalData => {
57 'MyOpsItemDataKey' => {
58 Type =>
59 'SearchableString', # values: SearchableString, String; OPTIONAL
60 Value => 'MyOpsItemDataValueString', # OPTIONAL
61 }, # key: min: 1, max: 128
62 }, # OPTIONAL
63 OperationalDataToDelete => [
64 'MyString', ... # OPTIONAL
65 ], # OPTIONAL
66 PlannedEndTime => '1970-01-01T01:00:00', # OPTIONAL
67 PlannedStartTime => '1970-01-01T01:00:00', # OPTIONAL
68 Priority => 1, # OPTIONAL
69 RelatedOpsItems => [
70 {
71 OpsItemId => 'MyString', # OPTIONAL
72  
73 },
74 ...
75 ], # OPTIONAL
76 Severity => 'MyOpsItemSeverity', # OPTIONAL
77 Status => 'Open', # OPTIONAL
78 Title => 'MyOpsItemTitle', # OPTIONAL
79 );
80  
81 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.
82 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/UpdateOpsItem>
83  
84 =head1 ATTRIBUTES
85  
86  
87 =head2 ActualEndTime => Str
88  
89 The time a runbook workflow ended. Currently reported only for the
90 OpsItem type C</aws/changerequest>.
91  
92  
93  
94 =head2 ActualStartTime => Str
95  
96 The time a runbook workflow started. Currently reported only for the
97 OpsItem type C</aws/changerequest>.
98  
99  
100  
101 =head2 Category => Str
102  
103 Specify a new category for an OpsItem.
104  
105  
106  
107 =head2 Description => Str
108  
109 Update the information about the OpsItem. Provide enough information so
110 that users reading this OpsItem for the first time understand the
111 issue.
112  
113  
114  
115 =head2 Notifications => ArrayRef[L<Paws::SSM::OpsItemNotification>]
116  
117 The Amazon Resource Name (ARN) of an SNS topic where notifications are
118 sent when this OpsItem is edited or changed.
119  
120  
121  
122 =head2 OperationalData => L<Paws::SSM::OpsItemOperationalData>
123  
124 Add new keys or edit existing key-value pairs of the OperationalData
125 map in the OpsItem object.
126  
127 Operational data is custom data that provides useful reference details
128 about the OpsItem. For example, you can specify log files, error
129 strings, license keys, troubleshooting tips, or other relevant data.
130 You enter operational data as key-value pairs. The key has a maximum
131 length of 128 characters. The value has a maximum size of 20 KB.
132  
133 Operational data keys I<can't> begin with the following: amazon, aws,
134 amzn, ssm, /amazon, /aws, /amzn, /ssm.
135  
136 You can choose to make the data searchable by other users in the
137 account or you can restrict search access. Searchable data means that
138 all users with access to the OpsItem Overview page (as provided by the
139 DescribeOpsItems API action) can view and search on the specified data.
140 Operational data that is not searchable is only viewable by users who
141 have access to the OpsItem (as provided by the GetOpsItem API action).
142  
143 Use the C</aws/resources> key in OperationalData to specify a related
144 resource in the request. Use the C</aws/automations> key in
145 OperationalData to associate an Automation runbook with the OpsItem. To
146 view AWS CLI example commands that use these keys, see Creating
147 OpsItems manually
148 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems)
149 in the I<AWS Systems Manager User Guide>.
150  
151  
152  
153 =head2 OperationalDataToDelete => ArrayRef[Str|Undef]
154  
155 Keys that you want to remove from the OperationalData map.
156  
157  
158  
159 =head2 B<REQUIRED> OpsItemId => Str
160  
161 The ID of the OpsItem.
162  
163  
164  
165 =head2 PlannedEndTime => Str
166  
167 The time specified in a change request for a runbook workflow to end.
168 Currently supported only for the OpsItem type C</aws/changerequest>.
169  
170  
171  
172 =head2 PlannedStartTime => Str
173  
174 The time specified in a change request for a runbook workflow to start.
175 Currently supported only for the OpsItem type C</aws/changerequest>.
176  
177  
178  
179 =head2 Priority => Int
180  
181 The importance of this OpsItem in relation to other OpsItems in the
182 system.
183  
184  
185  
186 =head2 RelatedOpsItems => ArrayRef[L<Paws::SSM::RelatedOpsItem>]
187  
188 One or more OpsItems that share something in common with the current
189 OpsItems. For example, related OpsItems can include OpsItems with
190 similar error messages, impacted resources, or statuses for the
191 impacted resource.
192  
193  
194  
195 =head2 Severity => Str
196  
197 Specify a new severity for an OpsItem.
198  
199  
200  
201 =head2 Status => Str
202  
203 The OpsItem status. Status can be C<Open>, C<In Progress>, or
204 C<Resolved>. For more information, see Editing OpsItem details
205 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details)
206 in the I<AWS Systems Manager User Guide>.
207  
208 Valid values are: C<"Open">, C<"InProgress">, C<"Resolved">, C<"Pending">, C<"TimedOut">, C<"Cancelling">, C<"Cancelled">, C<"Failed">, C<"CompletedWithSuccess">, C<"CompletedWithFailure">, C<"Scheduled">, C<"RunbookInProgress">, C<"PendingChangeCalendarOverride">, C<"ChangeCalendarOverrideApproved">, C<"ChangeCalendarOverrideRejected">, C<"PendingApproval">, C<"Approved">, C<"Rejected">
209  
210 =head2 Title => Str
211  
212 A short heading that describes the nature of the OpsItem and the
213 impacted resource.
214  
215  
216  
217  
218 =head1 SEE ALSO
219  
220 This class forms part of L<Paws>, documenting arguments for method UpdateOpsItem in L<Paws::SSM>
221  
222 =head1 BUGS and CONTRIBUTIONS
223  
224 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
225  
226 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
227  
228 =cut
229