Struct aws_sdk_computeoptimizer::client::fluent_builders::UpdateEnrollmentStatus [−][src]
pub struct UpdateEnrollmentStatus<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to UpdateEnrollmentStatus
.
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.
You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
Implementations
impl<C, M, R> UpdateEnrollmentStatus<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> UpdateEnrollmentStatus<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<UpdateEnrollmentStatusOutput, SdkError<UpdateEnrollmentStatusError>> where
R::Policy: SmithyRetryPolicy<UpdateEnrollmentStatusInputOperationOutputAlias, UpdateEnrollmentStatusOutput, UpdateEnrollmentStatusError, UpdateEnrollmentStatusInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<UpdateEnrollmentStatusOutput, SdkError<UpdateEnrollmentStatusError>> where
R::Policy: SmithyRetryPolicy<UpdateEnrollmentStatusInputOperationOutputAlias, UpdateEnrollmentStatusOutput, UpdateEnrollmentStatusError, UpdateEnrollmentStatusInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
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 Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the 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.
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 Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the 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.
Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.
Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for UpdateEnrollmentStatus<C, M, R>
impl<C, M, R> Send for UpdateEnrollmentStatus<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for UpdateEnrollmentStatus<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for UpdateEnrollmentStatus<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for UpdateEnrollmentStatus<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more