[ aws . compute-optimizer ]

update-enrollment-status

Description

Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is a master account of an organization, this action can also be used to enroll member accounts within the organization.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-enrollment-status
--status <value>
[--include-member-accounts | --no-include-member-accounts]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--status (string)

The new enrollment status of the account.

Accepted options are Active or Inactive . You will get an error if Pending or Failed are specified.

Possible values:

• Active

• Inactive

• Pending

• Failed

--include-member-accounts | --no-include-member-accounts (boolean)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

status -> (string)

The enrollment status of the account.

statusReason -> (string)

The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.