/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ComputeOptimizer::UpdateEnrollmentStatus

NAME

Paws::ComputeOptimizer::UpdateEnrollmentStatus - Arguments for method UpdateEnrollmentStatus on Paws::ComputeOptimizer

DESCRIPTION

This class represents the parameters used for calling the method UpdateEnrollmentStatus on the AWS Compute Optimizer service. Use the attributes of this class as arguments to method UpdateEnrollmentStatus.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEnrollmentStatus.

SYNOPSIS

 my $compute-optimizer = Paws->service('ComputeOptimizer');
 my $UpdateEnrollmentStatusResponse =
   $compute -optimizer->UpdateEnrollmentStatus(
   Status                => 'Active',
   IncludeMemberAccounts => 1,          # OPTIONAL
   );

 # Results:
 my $Status       = $UpdateEnrollmentStatusResponse->Status;
 my $StatusReason = $UpdateEnrollmentStatusResponse->StatusReason;

# Returns a L<Paws::ComputeOptimizer::UpdateEnrollmentStatusResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer/UpdateEnrollmentStatus

ATTRIBUTES

IncludeMemberAccounts => Bool

Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.

REQUIRED Status => Str

The new enrollment status of the account.

The following status options are available:

  • Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your AWS resources after you opt in. For more information, see Metrics analyzed by AWS Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html) in the AWS Compute Optimizer User Guide.

  • Inactive - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.

The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.

Valid values are: "Active", "Inactive", "Pending", "Failed"

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateEnrollmentStatus in Paws::ComputeOptimizer

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues