start_telemetry_evaluation async ¶

async def start_telemetry_evaluation(
    self,
    *,
    config_overrides: Optional[AsyncObservabilityAdminClientConfig] = None,
    regions: Optional["capo_observabilityadmin.types.regions.Regions"] = None,
    all_regions: Optional[
        "capo_observabilityadmin.types.all_regions.AllRegions"
    ] = None,
) -> None:
    """<p> This action begins onboarding the caller Amazon Web Services account to the telemetry config feature. </p>

    Args:
        regions: <p> An optional list of Amazon Web Services Regions to include in multi-region telemetry evaluation. The current region is always implicitly included and must not be specified in this list. When provided, telemetry evaluation starts in the current region and propagates to all specified regions. Mutually exclusive with <code>AllRegions</code>. If neither <code>Regions</code> nor <code>AllRegions</code> is provided, the operation applies only to the current region. </p>
        all_regions: <p> If set to <code>true</code>, telemetry evaluation starts in all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. The current region becomes the home region for managing multi-region evaluation. When new regions become available, evaluation automatically expands to include them. Mutually exclusive with <code>Regions</code>. </p>

    Raises:
        capo_observabilityadmin.errors.access_denied_exception.AccessDeniedException: <p> Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
        capo_observabilityadmin.errors.internal_server_exception.InternalServerException: <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
        capo_observabilityadmin.errors.too_many_requests_exception.TooManyRequestsException: <p> The request throughput limit was exceeded. </p>
        capo_observabilityadmin.errors.validation_exception.ValidationException: <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
        capo_observabilityadmin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_observabilityadmin.types.start_telemetry_evaluation_input.StartTelemetryEvaluationInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_observabilityadmin._operations.observability_admin.start_telemetry_evaluation

        (
            output,
            http_response,
        ) = await capo_observabilityadmin._operations.observability_admin.start_telemetry_evaluation.async_start_telemetry_evaluation(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartTelemetryEvaluation")
    )
    input_: capo_observabilityadmin.types.start_telemetry_evaluation_input.StartTelemetryEvaluationInput = {}
    if regions is not None:
        input_["regions"] = regions
    if all_regions is not None:
        input_["all_regions"] = all_regions

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