« blib/lib/Paws/Health/OrganizationAffectedEntitiesErrorItem.pm
↑ Summary
blib/lib/Paws/Health/OrganizationEventDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Health::OrganizationEvent; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str', request_name => 'endTime', traits => ['NameInRequest']); | ||
| 6 | has EventScopeCode => (is => 'ro', isa => 'Str', request_name => 'eventScopeCode', traits => ['NameInRequest']); | ||
| 7 | has EventTypeCategory => (is => 'ro', isa => 'Str', request_name => 'eventTypeCategory', traits => ['NameInRequest']); | ||
| 8 | has EventTypeCode => (is => 'ro', isa => 'Str', request_name => 'eventTypeCode', traits => ['NameInRequest']); | ||
| 9 | has LastUpdatedTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedTime', traits => ['NameInRequest']); | ||
| 10 | has Region => (is => 'ro', isa => 'Str', request_name => 'region', traits => ['NameInRequest']); | ||
| 11 | has Service => (is => 'ro', isa => 'Str', request_name => 'service', traits => ['NameInRequest']); | ||
| 12 | has StartTime => (is => 'ro', isa => 'Str', request_name => 'startTime', traits => ['NameInRequest']); | ||
| 13 | has StatusCode => (is => 'ro', isa => 'Str', request_name => 'statusCode', traits => ['NameInRequest']); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Health::OrganizationEvent | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Health::OrganizationEvent object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { Arn => $value, ..., StatusCode => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Health::OrganizationEvent object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->Arn | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Summary information about an event, returned by the | ||
| 46 | DescribeEventsForOrganization | ||
| 47 | (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) | ||
| 48 | operation. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Arn => Str | ||
| 54 | |||
| 55 | The unique identifier for the event. The event ARN has the | ||
| 56 | C<arn:aws:health:I<event-region>::event/I<SERVICE>/I<EVENT_TYPE_CODE>/I<EVENT_TYPE_PLUS_ID> | ||
| 57 | > format. | ||
| 58 | |||
| 59 | For example, an event ARN might look like the following: | ||
| 60 | |||
| 61 | C<arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456> | ||
| 62 | |||
| 63 | |||
| 64 | =head2 EndTime => Str | ||
| 65 | |||
| 66 | The date and time that the event ended. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 EventScopeCode => Str | ||
| 70 | |||
| 71 | This parameter specifies if the AWS Health event is a public AWS | ||
| 72 | service event or an account-specific event. | ||
| 73 | |||
| 74 | =over | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | If the C<eventScopeCode> value is C<PUBLIC>, then the | ||
| 79 | C<affectedAccounts> value is always empty. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | If the C<eventScopeCode> value is C<ACCOUNT_SPECIFIC>, then the | ||
| 84 | C<affectedAccounts> value lists the affected AWS accounts in your | ||
| 85 | organization. For example, if an event affects a service such as Amazon | ||
| 86 | Elastic Compute Cloud and you have AWS accounts that use that service, | ||
| 87 | those account IDs appear in the response. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | If the C<eventScopeCode> value is C<NONE>, then the C<eventArn> that | ||
| 92 | you specified in the request is invalid or doesn't exist. | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 EventTypeCategory => Str | ||
| 99 | |||
| 100 | The category of the event type. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 EventTypeCode => Str | ||
| 104 | |||
| 105 | The unique identifier for the event type. The format is | ||
| 106 | C<AWS_SERVICE_DESCRIPTION>. For example, | ||
| 107 | C<AWS_EC2_SYSTEM_MAINTENANCE_EVENT>. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 LastUpdatedTime => Str | ||
| 111 | |||
| 112 | The most recent date and time that the event was updated. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 Region => Str | ||
| 116 | |||
| 117 | The AWS Region name of the event. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 Service => Str | ||
| 121 | |||
| 122 | The AWS service that is affected by the event, such as EC2 and RDS. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 StartTime => Str | ||
| 126 | |||
| 127 | The date and time that the event began. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 StatusCode => Str | ||
| 131 | |||
| 132 | The most recent status of the event. Possible values are C<open>, | ||
| 133 | C<closed>, and C<upcoming>. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, describing an object used in L<Paws::Health> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 |