DescribeDeliveries
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 AWS resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some AWS services support being configured as a delivery source. These services are listed in Enable logging from AWS services.
Request Syntax
{
"limit": number,
"nextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- limit
-
Optionally specify the maximum number of deliveries to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- nextToken
-
The token for the next set of items to return. The token expires after 24 hours.
Type: String
Length Constraints: Minimum length of 1.
Required: No
Response Syntax
{
"deliveries": [
{
"arn": "string",
"deliveryDestinationArn": "string",
"deliveryDestinationType": "string",
"deliverySourceName": "string",
"fieldDelimiter": "string",
"id": "string",
"recordFields": [ "string" ],
"s3DeliveryConfiguration": {
"enableHiveCompatiblePath": boolean,
"suffixPath": "string"
},
"tags": {
"string" : "string"
}
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- deliveries
-
An array of structures. Each structure contains information about one delivery in the account.
Type: Array of Delivery objects
- nextToken
-
The token for the next set of items to return. The token expires after 24 hours.
Type: String
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ServiceQuotaExceededException
-
This request exceeds a service quota.
HTTP Status Code: 400
- ServiceUnavailableException
-
The service cannot complete the request.
HTTP Status Code: 500
- ThrottlingException
-
The request was throttled because of quota limits.
HTTP Status Code: 400
- ValidationException
-
One of the parameters for the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
