| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::OpsItem; | ||
| 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 CreatedBy => (is => 'ro', isa => 'Str'); | ||
| 8 | has CreatedTime => (is => 'ro', isa => 'Str'); | ||
| 9 | has Description => (is => 'ro', isa => 'Str'); | ||
| 10 | has LastModifiedBy => (is => 'ro', isa => 'Str'); | ||
| 11 | has LastModifiedTime => (is => 'ro', isa => 'Str'); | ||
| 12 | has Notifications => (is => 'ro', isa => 'ArrayRef[Paws::SSM::OpsItemNotification]'); | ||
| 13 | has OperationalData => (is => 'ro', isa => 'Paws::SSM::OpsItemOperationalData'); | ||
| 14 | has OpsItemId => (is => 'ro', isa => 'Str'); | ||
| 15 | has OpsItemType => (is => 'ro', isa => 'Str'); | ||
| 16 | has PlannedEndTime => (is => 'ro', isa => 'Str'); | ||
| 17 | has PlannedStartTime => (is => 'ro', isa => 'Str'); | ||
| 18 | has Priority => (is => 'ro', isa => 'Int'); | ||
| 19 | has RelatedOpsItems => (is => 'ro', isa => 'ArrayRef[Paws::SSM::RelatedOpsItem]'); | ||
| 20 | has Severity => (is => 'ro', isa => 'Str'); | ||
| 21 | has Source => (is => 'ro', isa => 'Str'); | ||
| 22 | has Status => (is => 'ro', isa => 'Str'); | ||
| 23 | has Title => (is => 'ro', isa => 'Str'); | ||
| 24 | has Version => (is => 'ro', isa => 'Str'); | ||
| 25 | |||
| 26 | 1; | ||
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::SSM::OpsItem | ||
| 33 | |||
| 34 | =head1 USAGE | ||
| 35 | |||
| 36 | This class represents one of two things: | ||
| 37 | |||
| 38 | =head3 Arguments in a call to a service | ||
| 39 | |||
| 40 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 41 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 42 | |||
| 43 | As an example, if Att1 is expected to be a Paws::SSM::OpsItem object: | ||
| 44 | |||
| 45 | $service_obj->Method(Att1 => { ActualEndTime => $value, ..., Version => $value }); | ||
| 46 | |||
| 47 | =head3 Results returned from an API call | ||
| 48 | |||
| 49 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::OpsItem object: | ||
| 50 | |||
| 51 | $result = $service_obj->Method(...); | ||
| 52 | $result->Att1->ActualEndTime | ||
| 53 | |||
| 54 | =head1 DESCRIPTION | ||
| 55 | |||
| 56 | Operations engineers and IT professionals use OpsCenter to view, | ||
| 57 | investigate, and remediate operational issues impacting the performance | ||
| 58 | and health of their AWS resources. For more information, see AWS | ||
| 59 | Systems Manager OpsCenter | ||
| 60 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) | ||
| 61 | in the I<AWS Systems Manager User Guide>. | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ActualEndTime => Str | ||
| 67 | |||
| 68 | The time a runbook workflow ended. Currently reported only for the | ||
| 69 | OpsItem type C</aws/changerequest>. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 ActualStartTime => Str | ||
| 73 | |||
| 74 | The time a runbook workflow started. Currently reported only for the | ||
| 75 | OpsItem type C</aws/changerequest>. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Category => Str | ||
| 79 | |||
| 80 | An OpsItem category. Category options include: Availability, Cost, | ||
| 81 | Performance, Recovery, Security. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 CreatedBy => Str | ||
| 85 | |||
| 86 | The ARN of the AWS account that created the OpsItem. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 CreatedTime => Str | ||
| 90 | |||
| 91 | The date and time the OpsItem was created. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Description => Str | ||
| 95 | |||
| 96 | The OpsItem description. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 LastModifiedBy => Str | ||
| 100 | |||
| 101 | The ARN of the AWS account that last updated the OpsItem. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 LastModifiedTime => Str | ||
| 105 | |||
| 106 | The date and time the OpsItem was last updated. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 Notifications => ArrayRef[L<Paws::SSM::OpsItemNotification>] | ||
| 110 | |||
| 111 | The Amazon Resource Name (ARN) of an SNS topic where notifications are | ||
| 112 | sent when this OpsItem is edited or changed. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 OperationalData => L<Paws::SSM::OpsItemOperationalData> | ||
| 116 | |||
| 117 | Operational data is custom data that provides useful reference details | ||
| 118 | about the OpsItem. For example, you can specify log files, error | ||
| 119 | strings, license keys, troubleshooting tips, or other relevant data. | ||
| 120 | You enter operational data as key-value pairs. The key has a maximum | ||
| 121 | length of 128 characters. The value has a maximum size of 20 KB. | ||
| 122 | |||
| 123 | Operational data keys I<can't> begin with the following: amazon, aws, | ||
| 124 | amzn, ssm, /amazon, /aws, /amzn, /ssm. | ||
| 125 | |||
| 126 | You can choose to make the data searchable by other users in the | ||
| 127 | account or you can restrict search access. Searchable data means that | ||
| 128 | all users with access to the OpsItem Overview page (as provided by the | ||
| 129 | DescribeOpsItems API action) can view and search on the specified data. | ||
| 130 | Operational data that is not searchable is only viewable by users who | ||
| 131 | have access to the OpsItem (as provided by the GetOpsItem API action). | ||
| 132 | |||
| 133 | Use the C</aws/resources> key in OperationalData to specify a related | ||
| 134 | resource in the request. Use the C</aws/automations> key in | ||
| 135 | OperationalData to associate an Automation runbook with the OpsItem. To | ||
| 136 | view AWS CLI example commands that use these keys, see Creating | ||
| 137 | OpsItems manually | ||
| 138 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) | ||
| 139 | in the I<AWS Systems Manager User Guide>. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 OpsItemId => Str | ||
| 143 | |||
| 144 | The ID of the OpsItem. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 OpsItemType => Str | ||
| 148 | |||
| 149 | The type of OpsItem. Currently, the only valid values are | ||
| 150 | C</aws/changerequest> and C</aws/issue>. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 PlannedEndTime => Str | ||
| 154 | |||
| 155 | The time specified in a change request for a runbook workflow to end. | ||
| 156 | Currently supported only for the OpsItem type C</aws/changerequest>. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 PlannedStartTime => Str | ||
| 160 | |||
| 161 | The time specified in a change request for a runbook workflow to start. | ||
| 162 | Currently supported only for the OpsItem type C</aws/changerequest>. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 Priority => Int | ||
| 166 | |||
| 167 | The importance of this OpsItem in relation to other OpsItems in the | ||
| 168 | system. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 RelatedOpsItems => ArrayRef[L<Paws::SSM::RelatedOpsItem>] | ||
| 172 | |||
| 173 | One or more OpsItems that share something in common with the current | ||
| 174 | OpsItem. For example, related OpsItems can include OpsItems with | ||
| 175 | similar error messages, impacted resources, or statuses for the | ||
| 176 | impacted resource. | ||
| 177 | |||
| 178 | |||
| 179 | =head2 Severity => Str | ||
| 180 | |||
| 181 | The severity of the OpsItem. Severity options range from 1 to 4. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 Source => Str | ||
| 185 | |||
| 186 | The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The | ||
| 187 | impacted resource is a subset of source. | ||
| 188 | |||
| 189 | |||
| 190 | =head2 Status => Str | ||
| 191 | |||
| 192 | The OpsItem status. Status can be C<Open>, C<In Progress>, or | ||
| 193 | C<Resolved>. For more information, see Editing OpsItem details | ||
| 194 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html) | ||
| 195 | in the I<AWS Systems Manager User Guide>. | ||
| 196 | |||
| 197 | |||
| 198 | =head2 Title => Str | ||
| 199 | |||
| 200 | A short heading that describes the nature of the OpsItem and the | ||
| 201 | impacted resource. | ||
| 202 | |||
| 203 | |||
| 204 | =head2 Version => Str | ||
| 205 | |||
| 206 | The version of this OpsItem. Each time the OpsItem is edited the | ||
| 207 | version number increments by one. | ||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | =head1 SEE ALSO | ||
| 212 | |||
| 213 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 214 | |||
| 215 | =head1 BUGS and CONTRIBUTIONS | ||
| 216 | |||
| 217 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 218 | |||
| 219 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 220 | |||
| 221 | =cut | ||
| 222 |