Skip to content

describe_deliveries

describe_deliveries(
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[DescribeLimit] = None,
) -> DescribeDeliveriesResponse

Retrieves a list of the deliveries that have been created in the account.

A delivery is a connection between a delivery source and a delivery destination .

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

Parameters:

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

    Optionally specify the maximum number of deliveries to return in the response.

Raises:

Source code in docs_src/capo_cloudwatch_logs/_services/cloud_watch_logs.py
def describe_deliveries(
    self,
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = 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_deliveries_response.DescribeDeliveriesResponse":
    """<p>Retrieves a list of the deliveries that have been created in the account.</p> <p>A <i>delivery</i> is a connection between a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html"> <i>delivery source</i> </a> and a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html"> <i>delivery destination</i> </a>.</p> <p>A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services services.</a> </p>

    Args:
        limit: <p>Optionally specify the maximum number of deliveries to return in the response.</p>

    Raises:
        capo_cloudwatch_logs.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This request exceeds a service quota.</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.
    """

    def _handler(
        req: "OperationRequest[capo_cloudwatch_logs.types.describe_deliveries_request.DescribeDeliveriesRequest]",
    ) -> OperationResponse[
        "capo_cloudwatch_logs.types.describe_deliveries_response.DescribeDeliveriesResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_deliveries

        output, http_response = (
            capo_cloudwatch_logs._operations.logs_20140328.describe_deliveries.describe_deliveries(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDeliveries")
    )
    input_: capo_cloudwatch_logs.types.describe_deliveries_request.DescribeDeliveriesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output