« blib/lib/Paws/Detective/ListTagsForResourceResponse.pm
↑ Summary
blib/lib/Paws/Detective/RejectInvitation.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Detective::MemberDetail; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str'); | ||
| 5 | has AdministratorId => (is => 'ro', isa => 'Str'); | ||
| 6 | has DisabledReason => (is => 'ro', isa => 'Str'); | ||
| 7 | has EmailAddress => (is => 'ro', isa => 'Str'); | ||
| 8 | has GraphArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has InvitedTime => (is => 'ro', isa => 'Str'); | ||
| 10 | has MasterId => (is => 'ro', isa => 'Str'); | ||
| 11 | has PercentOfGraphUtilization => (is => 'ro', isa => 'Num'); | ||
| 12 | has PercentOfGraphUtilizationUpdatedTime => (is => 'ro', isa => 'Str'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str'); | ||
| 14 | has UpdatedTime => (is => 'ro', isa => 'Str'); | ||
| 15 | has VolumeUsageInBytes => (is => 'ro', isa => 'Int'); | ||
| 16 | has VolumeUsageUpdatedTime => (is => 'ro', isa => 'Str'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Detective::MemberDetail | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::Detective::MemberDetail object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { AccountId => $value, ..., VolumeUsageUpdatedTime => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::Detective::MemberDetail object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->AccountId | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Details about a member account that was invited to contribute to a | ||
| 49 | behavior graph. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 AccountId => Str | ||
| 55 | |||
| 56 | The AWS account identifier for the member account. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 AdministratorId => Str | ||
| 60 | |||
| 61 | The AWS account identifier of the administrator account for the | ||
| 62 | behavior graph. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DisabledReason => Str | ||
| 66 | |||
| 67 | For member accounts with a status of C<ACCEPTED_BUT_DISABLED>, the | ||
| 68 | reason that the member account is not enabled. | ||
| 69 | |||
| 70 | The reason can have one of the following values: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<VOLUME_TOO_HIGH> - Indicates that adding the member account would | ||
| 77 | cause the data volume for the behavior graph to be too high. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<VOLUME_UNKNOWN> - Indicates that Detective is unable to verify the | ||
| 82 | data volume for the member account. This is usually because the member | ||
| 83 | account is not enrolled in Amazon GuardDuty. | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 EmailAddress => Str | ||
| 90 | |||
| 91 | The AWS account root user email address for the member account. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 GraphArn => Str | ||
| 95 | |||
| 96 | The ARN of the behavior graph that the member account was invited to. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 InvitedTime => Str | ||
| 100 | |||
| 101 | The date and time that Detective sent the invitation to the member | ||
| 102 | account. The value is in milliseconds since the epoch. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 MasterId => Str | ||
| 106 | |||
| 107 | The AWS account identifier of the administrator account for the | ||
| 108 | behavior graph. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 PercentOfGraphUtilization => Num | ||
| 112 | |||
| 113 | The member account data volume as a percentage of the maximum allowed | ||
| 114 | data volume. 0 indicates 0 percent, and 100 indicates 100 percent. | ||
| 115 | |||
| 116 | Note that this is not the percentage of the behavior graph data volume. | ||
| 117 | |||
| 118 | For example, the data volume for the behavior graph is 80 GB per day. | ||
| 119 | The maximum data volume is 160 GB per day. If the data volume for the | ||
| 120 | member account is 40 GB per day, then C<PercentOfGraphUtilization> is | ||
| 121 | 25. It represents 25% of the maximum allowed data volume. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 PercentOfGraphUtilizationUpdatedTime => Str | ||
| 125 | |||
| 126 | The date and time when the graph utilization percentage was last | ||
| 127 | updated. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Status => Str | ||
| 131 | |||
| 132 | The current membership status of the member account. The status can | ||
| 133 | have one of the following values: | ||
| 134 | |||
| 135 | =over | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | C<INVITED> - Indicates that the member was sent an invitation but has | ||
| 140 | not yet responded. | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | C<VERIFICATION_IN_PROGRESS> - Indicates that Detective is verifying | ||
| 145 | that the account identifier and email address provided for the member | ||
| 146 | account match. If they do match, then Detective sends the invitation. | ||
| 147 | If the email address and account identifier don't match, then the | ||
| 148 | member cannot be added to the behavior graph. | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | C<VERIFICATION_FAILED> - Indicates that the account and email address | ||
| 153 | provided for the member account do not match, and Detective did not | ||
| 154 | send an invitation to the account. | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | C<ENABLED> - Indicates that the member account accepted the invitation | ||
| 159 | to contribute to the behavior graph. | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | C<ACCEPTED_BUT_DISABLED> - Indicates that the member account accepted | ||
| 164 | the invitation but is prevented from contributing data to the behavior | ||
| 165 | graph. C<DisabledReason> provides the reason why the member account is | ||
| 166 | not enabled. | ||
| 167 | |||
| 168 | =back | ||
| 169 | |||
| 170 | Member accounts that declined an invitation or that were removed from | ||
| 171 | the behavior graph are not included. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 UpdatedTime => Str | ||
| 175 | |||
| 176 | The date and time that the member account was last updated. The value | ||
| 177 | is in milliseconds since the epoch. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 VolumeUsageInBytes => Int | ||
| 181 | |||
| 182 | The data volume in bytes per day for the member account. | ||
| 183 | |||
| 184 | |||
| 185 | =head2 VolumeUsageUpdatedTime => Str | ||
| 186 | |||
| 187 | The data and time when the member account data volume was last updated. | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | =head1 SEE ALSO | ||
| 192 | |||
| 193 | This class forms part of L<Paws>, describing an object used in L<Paws::Detective> | ||
| 194 | |||
| 195 | =head1 BUGS and CONTRIBUTIONS | ||
| 196 | |||
| 197 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 198 | |||
| 199 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 200 | |||
| 201 | =cut | ||
| 202 |