« blib/lib/Paws/ComputeOptimizer/Summary.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/UpdateEnrollmentStatusResponse.pm »
| 1 | |||
| 2 | package Paws::ComputeOptimizer::UpdateEnrollmentStatus; | ||
| 3 | use Moose; | ||
| 4 | has IncludeMemberAccounts => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeMemberAccounts' ); | ||
| 5 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status' , required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEnrollmentStatus'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ComputeOptimizer::UpdateEnrollmentStatusResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::ComputeOptimizer::UpdateEnrollmentStatus - Arguments for method UpdateEnrollmentStatus on L<Paws::ComputeOptimizer> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method UpdateEnrollmentStatus on the | ||
| 23 | L<AWS Compute Optimizer|Paws::ComputeOptimizer> service. Use the attributes of this class | ||
| 24 | as arguments to method UpdateEnrollmentStatus. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEnrollmentStatus. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $compute-optimizer = Paws->service('ComputeOptimizer'); | ||
| 31 | my $UpdateEnrollmentStatusResponse = | ||
| 32 | $compute -optimizer->UpdateEnrollmentStatus( | ||
| 33 | Status => 'Active', | ||
| 34 | IncludeMemberAccounts => 1, # OPTIONAL | ||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $Status = $UpdateEnrollmentStatusResponse->Status; | ||
| 39 | my $StatusReason = $UpdateEnrollmentStatusResponse->StatusReason; | ||
| 40 | |||
| 41 | # Returns a L<Paws::ComputeOptimizer::UpdateEnrollmentStatusResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer/UpdateEnrollmentStatus> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 IncludeMemberAccounts => Bool | ||
| 50 | |||
| 51 | Indicates whether to enroll member accounts of the organization if the | ||
| 52 | account is the management account of an organization. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> Status => Str | ||
| 57 | |||
| 58 | The new enrollment status of the account. | ||
| 59 | |||
| 60 | The following status options are available: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<Active> - Opts in your account to the Compute Optimizer service. | ||
| 67 | Compute Optimizer begins analyzing the configuration and utilization | ||
| 68 | metrics of your AWS resources after you opt in. For more information, | ||
| 69 | see Metrics analyzed by AWS Compute Optimizer | ||
| 70 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html) | ||
| 71 | in the I<AWS Compute Optimizer User Guide>. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | C<Inactive> - Opts out your account from the Compute Optimizer service. | ||
| 76 | Your account's recommendations and related metrics data will be deleted | ||
| 77 | from Compute Optimizer after you opt out. | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | The C<Pending> and C<Failed> options cannot be used to update the | ||
| 82 | enrollment status of an account. They are returned in the response of a | ||
| 83 | request to update the enrollment status of an account. | ||
| 84 | |||
| 85 | Valid values are: C<"Active">, C<"Inactive">, C<"Pending">, C<"Failed"> | ||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method UpdateEnrollmentStatus in L<Paws::ComputeOptimizer> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |