Skip to content

describe_configuration_templates async

describe_configuration_templates(
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    service: Optional[Service] = None,
    log_types: Optional[LogTypes] = None,
    resource_types: Optional[ResourceTypes] = None,
    delivery_destination_types: Optional[DeliveryDestinationTypes] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[DescribeLimit] = None,
) -> DescribeConfigurationTemplatesResponse

Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.

Parameters:

  • service (Optional[Service], default: None ) –

    Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here.

  • log_types (Optional[LogTypes], default: None ) –

    Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here.

  • resource_types (Optional[ResourceTypes], default: None ) –

    Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here.

  • delivery_destination_types (Optional[DeliveryDestinationTypes], default: None ) –

    Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.

  • limit (Optional[DescribeLimit], default: None ) –

    Use this parameter to limit the number of configuration templates that are returned in the response.

Raises:

Source code in docs_src/capo_cloudwatch_logs/_services/async_cloud_watch_logs.py
async def describe_configuration_templates(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    service: Optional["capo_cloudwatch_logs.types.service.Service"] = None,
    log_types: Optional["capo_cloudwatch_logs.types.log_types.LogTypes"] = None,
    resource_types: Optional[
        "capo_cloudwatch_logs.types.resource_types.ResourceTypes"
    ] = None,
    delivery_destination_types: Optional[
        "capo_cloudwatch_logs.types.delivery_destination_types.DeliveryDestinationTypes"
    ] = None,
    next_token: Optional["capo_cloudwatch_logs.types.next_token.NextToken"] = None,
    limit: Optional[
        "capo_cloudwatch_logs.types.describe_limit.DescribeLimit"
    ] = None,
) -> "capo_cloudwatch_logs.types.describe_configuration_templates_response.DescribeConfigurationTemplatesResponse":
    """<p>Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.</p>

    Args:
        service: <p>Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here.</p>
        log_types: <p>Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here.</p>
        resource_types: <p>Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here.</p>
        delivery_destination_types: <p>Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.</p>
        limit: <p>Use this parameter to limit the number of configuration templates that are returned in the response.</p>

    Raises:
        capo_cloudwatch_logs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_cloudwatch_logs.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service cannot complete the request.</p>
        capo_cloudwatch_logs.errors.throttling_exception.ThrottlingException: <p>The request was throttled because of quota limits.</p>
        capo_cloudwatch_logs.errors.validation_exception.ValidationException: <p>One of the parameters for the request is not valid.</p>
        capo_cloudwatch_logs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch_logs.types.describe_configuration_templates_request.DescribeConfigurationTemplatesRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch_logs.types.describe_configuration_templates_response.DescribeConfigurationTemplatesResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_configuration_templates

        (
            output,
            http_response,
        ) = await capo_cloudwatch_logs._operations.logs_20140328.describe_configuration_templates.async_describe_configuration_templates(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConfigurationTemplates")
    )
    input_: capo_cloudwatch_logs.types.describe_configuration_templates_request.DescribeConfigurationTemplatesRequest = {}
    if service is not None:
        input_["service"] = service
    if log_types is not None:
        input_["log_types"] = log_types
    if resource_types is not None:
        input_["resource_types"] = resource_types
    if delivery_destination_types is not None:
        input_["delivery_destination_types"] = delivery_destination_types
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

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