Skip to content

get_enrollment_statuses_for_organization async

get_enrollment_statuses_for_organization(
    *,
    config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
    filters: Optional[EnrollmentFilters] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> GetEnrollmentStatusesForOrganizationResponse

Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.

To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.

Parameters:

  • filters (Optional[EnrollmentFilters], default: None ) –

    An array of objects to specify a filter that returns a more specific list of account enrollment statuses.

  • next_token (Optional[NextToken], default: None ) –

    The token to advance to the next page of account enrollment statuses.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.

    To retrieve the remaining results, make another request with the returned nextToken value.

Raises:

Source code in docs_src/capo_compute_optimizer/_services/async_compute_optimizer.py
async def get_enrollment_statuses_for_organization(
    self,
    *,
    config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
    filters: Optional[
        "capo_compute_optimizer.types.enrollment_filters.EnrollmentFilters"
    ] = None,
    next_token: Optional[
        "capo_compute_optimizer.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_compute_optimizer.types.max_results.MaxResults"
    ] = None,
) -> "capo_compute_optimizer.types.get_enrollment_statuses_for_organization_response.GetEnrollmentStatusesForOrganizationResponse":
    """<p>Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.</p> <p>To get the enrollment status of standalone accounts, use the <a>GetEnrollmentStatus</a> action.</p>

    Args:
        filters: <p>An array of objects to specify a filter that returns a more specific list of account enrollment statuses.</p>
        next_token: <p>The token to advance to the next page of account enrollment statuses.</p>
        max_results: <p>The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>

    Raises:
        capo_compute_optimizer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_compute_optimizer.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Try your call again.</p>
        capo_compute_optimizer.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value supplied for the input parameter is out of range or not valid.</p>
        capo_compute_optimizer.errors.missing_authentication_token.MissingAuthenticationToken: <p>The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.</p>
        capo_compute_optimizer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the server.</p>
        capo_compute_optimizer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_compute_optimizer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_compute_optimizer.types.get_enrollment_statuses_for_organization_request.GetEnrollmentStatusesForOrganizationRequest]",
    ) -> AsyncOperationResponse[
        "capo_compute_optimizer.types.get_enrollment_statuses_for_organization_response.GetEnrollmentStatusesForOrganizationResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.get_enrollment_statuses_for_organization

        (
            output,
            http_response,
        ) = await capo_compute_optimizer._operations.compute_optimizer_service.get_enrollment_statuses_for_organization.async_get_enrollment_statuses_for_organization(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEnrollmentStatusesForOrganization")
    )
    input_: capo_compute_optimizer.types.get_enrollment_statuses_for_organization_request.GetEnrollmentStatusesForOrganizationRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output