blib/lib/Paws/SSM/CreateOpsItem.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::CreateOpsItem;
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', required => 1);
8 has Notifications => (is => 'ro', isa => 'ArrayRef[Paws::SSM::OpsItemNotification]');
9 has OperationalData => (is => 'ro', isa => 'Paws::SSM::OpsItemOperationalData');
10 has OpsItemType => (is => 'ro', isa => 'Str');
11 has PlannedEndTime => (is => 'ro', isa => 'Str');
12 has PlannedStartTime => (is => 'ro', isa => 'Str');
13 has Priority => (is => 'ro', isa => 'Int');
14 has RelatedOpsItems => (is => 'ro', isa => 'ArrayRef[Paws::SSM::RelatedOpsItem]');
15 has Severity => (is => 'ro', isa => 'Str');
16 has Source => (is => 'ro', isa => 'Str', required => 1);
17 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]');
18 has Title => (is => 'ro', isa => 'Str', required => 1);
19  
20 use MooseX::ClassAttribute;
21  
22 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateOpsItem');
23 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::CreateOpsItemResponse');
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::CreateOpsItem - Arguments for method CreateOpsItem on L<Paws::SSM>
32  
33 =head1 DESCRIPTION
34  
35 This class represents the parameters used for calling the method CreateOpsItem on the
36 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
37 as arguments to method CreateOpsItem.
38  
39 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateOpsItem.
40  
41 =head1 SYNOPSIS
42  
43 my $ssm = Paws->service('SSM');
44 my $CreateOpsItemResponse = $ssm->CreateOpsItem(
45 Description => 'MyOpsItemDescription',
46 Source => 'MyOpsItemSource',
47 Title => 'MyOpsItemTitle',
48 ActualEndTime => '1970-01-01T01:00:00', # OPTIONAL
49 ActualStartTime => '1970-01-01T01:00:00', # OPTIONAL
50 Category => 'MyOpsItemCategory', # OPTIONAL
51 Notifications => [
52 {
53 Arn => 'MyString', # OPTIONAL
54 },
55 ...
56 ], # OPTIONAL
57 OperationalData => {
58 'MyOpsItemDataKey' => {
59 Type =>
60 'SearchableString', # values: SearchableString, String; OPTIONAL
61 Value => 'MyOpsItemDataValueString', # OPTIONAL
62 }, # key: min: 1, max: 128
63 }, # OPTIONAL
64 OpsItemType => 'MyOpsItemType', # OPTIONAL
65 PlannedEndTime => '1970-01-01T01:00:00', # OPTIONAL
66 PlannedStartTime => '1970-01-01T01:00:00', # OPTIONAL
67 Priority => 1, # OPTIONAL
68 RelatedOpsItems => [
69 {
70 OpsItemId => 'MyString', # OPTIONAL
71  
72 },
73 ...
74 ], # OPTIONAL
75 Severity => 'MyOpsItemSeverity', # OPTIONAL
76 Tags => [
77 {
78 Key => 'MyTagKey', # min: 1, max: 128
79 Value => 'MyTagValue', # min: 1, max: 256
80  
81 },
82 ...
83 ], # OPTIONAL
84 );
85  
86 # Results:
87 my $OpsItemId = $CreateOpsItemResponse->OpsItemId;
88  
89 # Returns a L<Paws::SSM::CreateOpsItemResponse> object.
90  
91 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.
92 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/CreateOpsItem>
93  
94 =head1 ATTRIBUTES
95  
96  
97 =head2 ActualEndTime => Str
98  
99 The time a runbook workflow ended. Currently reported only for the
100 OpsItem type C</aws/changerequest>.
101  
102  
103  
104 =head2 ActualStartTime => Str
105  
106 The time a runbook workflow started. Currently reported only for the
107 OpsItem type C</aws/changerequest>.
108  
109  
110  
111 =head2 Category => Str
112  
113 Specify a category to assign to an OpsItem.
114  
115  
116  
117 =head2 B<REQUIRED> Description => Str
118  
119 Information about the OpsItem.
120  
121  
122  
123 =head2 Notifications => ArrayRef[L<Paws::SSM::OpsItemNotification>]
124  
125 The Amazon Resource Name (ARN) of an SNS topic where notifications are
126 sent when this OpsItem is edited or changed.
127  
128  
129  
130 =head2 OperationalData => L<Paws::SSM::OpsItemOperationalData>
131  
132 Operational data is custom data that provides useful reference details
133 about the OpsItem. For example, you can specify log files, error
134 strings, license keys, troubleshooting tips, or other relevant data.
135 You enter operational data as key-value pairs. The key has a maximum
136 length of 128 characters. The value has a maximum size of 20 KB.
137  
138 Operational data keys I<can't> begin with the following: amazon, aws,
139 amzn, ssm, /amazon, /aws, /amzn, /ssm.
140  
141 You can choose to make the data searchable by other users in the
142 account or you can restrict search access. Searchable data means that
143 all users with access to the OpsItem Overview page (as provided by the
144 DescribeOpsItems API action) can view and search on the specified data.
145 Operational data that is not searchable is only viewable by users who
146 have access to the OpsItem (as provided by the GetOpsItem API action).
147  
148 Use the C</aws/resources> key in OperationalData to specify a related
149 resource in the request. Use the C</aws/automations> key in
150 OperationalData to associate an Automation runbook with the OpsItem. To
151 view AWS CLI example commands that use these keys, see Creating
152 OpsItems manually
153 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems)
154 in the I<AWS Systems Manager User Guide>.
155  
156  
157  
158 =head2 OpsItemType => Str
159  
160 The type of OpsItem to create. Currently, the only valid values are
161 C</aws/changerequest> and C</aws/issue>.
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 severity to assign to an OpsItem.
198  
199  
200  
201 =head2 B<REQUIRED> Source => Str
202  
203 The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
204  
205 The source name can't contain the following strings: aws, amazon, and
206 amzn.
207  
208  
209  
210 =head2 Tags => ArrayRef[L<Paws::SSM::Tag>]
211  
212 Optional metadata that you assign to a resource. You can restrict
213 access to OpsItems by using an inline IAM policy that specifies tags.
214 For more information, see Getting started with OpsCenter
215 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions)
216 in the I<AWS Systems Manager User Guide>.
217  
218 Tags use a key-value pair. For example:
219  
220 C<Key=Department,Value=Finance>
221  
222 To add tags to an existing OpsItem, use the AddTagsToResource action.
223  
224  
225  
226 =head2 B<REQUIRED> Title => Str
227  
228 A short heading that describes the nature of the OpsItem and the
229 impacted resource.
230  
231  
232  
233  
234 =head1 SEE ALSO
235  
236 This class forms part of L<Paws>, documenting arguments for method CreateOpsItem in L<Paws::SSM>
237  
238 =head1 BUGS and CONTRIBUTIONS
239  
240 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
241  
242 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
243  
244 =cut
245