« blib/lib/Paws/Config/OrganizationConfigRule.pm
↑ Summary
blib/lib/Paws/Config/OrganizationConformancePack.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Config::OrganizationConfigRuleStatus; | ||
| 3 | use Moose; | ||
| 4 | has ErrorCode => (is => 'ro', isa => 'Str'); | ||
| 5 | has ErrorMessage => (is => 'ro', isa => 'Str'); | ||
| 6 | has LastUpdateTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has OrganizationConfigRuleName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has OrganizationRuleStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Config::OrganizationConfigRuleStatus | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Config::OrganizationConfigRuleStatus object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { ErrorCode => $value, ..., OrganizationRuleStatus => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Config::OrganizationConfigRuleStatus object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->ErrorCode | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Returns the status for an organization config rule in an organization. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 ErrorCode => Str | ||
| 46 | |||
| 47 | An error code that is returned when organization config rule creation | ||
| 48 | or deletion has failed. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ErrorMessage => Str | ||
| 52 | |||
| 53 | An error message indicating that organization config rule creation or | ||
| 54 | deletion failed due to an error. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 LastUpdateTime => Str | ||
| 58 | |||
| 59 | The timestamp of the last update. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> OrganizationConfigRuleName => Str | ||
| 63 | |||
| 64 | The name that you assign to organization config rule. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> OrganizationRuleStatus => Str | ||
| 68 | |||
| 69 | Indicates deployment status of an organization config rule. When master | ||
| 70 | account calls PutOrganizationConfigRule action for the first time, | ||
| 71 | config rule status is created in all the member accounts. When master | ||
| 72 | account calls PutOrganizationConfigRule action for the second time, | ||
| 73 | config rule status is updated in all the member accounts. Additionally, | ||
| 74 | config rule status is updated when one or more member accounts join or | ||
| 75 | leave an organization. Config rule status is deleted when the master | ||
| 76 | account deletes OrganizationConfigRule in all the member accounts and | ||
| 77 | disables service access for C<config-multiaccountsetup.amazonaws.com>. | ||
| 78 | |||
| 79 | AWS Config sets the state of the rule to: | ||
| 80 | |||
| 81 | =over | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<CREATE_SUCCESSFUL> when an organization config rule has been | ||
| 86 | successfully created in all the member accounts. | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<CREATE_IN_PROGRESS> when an organization config rule creation is in | ||
| 91 | progress. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<CREATE_FAILED> when an organization config rule creation failed in | ||
| 96 | one or more member accounts within that organization. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<DELETE_FAILED> when an organization config rule deletion failed in | ||
| 101 | one or more member accounts within that organization. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<DELETE_IN_PROGRESS> when an organization config rule deletion is in | ||
| 106 | progress. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<DELETE_SUCCESSFUL> when an organization config rule has been | ||
| 111 | successfully deleted from all the member accounts. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<UPDATE_SUCCESSFUL> when an organization config rule has been | ||
| 116 | successfully updated in all the member accounts. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<UPDATE_IN_PROGRESS> when an organization config rule update is in | ||
| 121 | progress. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<UPDATE_FAILED> when an organization config rule update failed in one | ||
| 126 | or more member accounts within that organization. | ||
| 127 | |||
| 128 | =back | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, describing an object used in L<Paws::Config> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |