DescribeDeliveryChannelStatus
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all delivery channels associated with the account.
Note
Currently, you can specify only one delivery channel per region in your account.
Request Syntax
{
"DeliveryChannelNames": [ "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.
- DeliveryChannelNames
-
A list of delivery channel names.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
Response Syntax
{
"DeliveryChannelsStatus": [
{
"configHistoryDeliveryInfo": {
"lastAttemptTime": number,
"lastErrorCode": "string",
"lastErrorMessage": "string",
"lastStatus": "string",
"lastSuccessfulTime": number,
"nextDeliveryTime": number
},
"configSnapshotDeliveryInfo": {
"lastAttemptTime": number,
"lastErrorCode": "string",
"lastErrorMessage": "string",
"lastStatus": "string",
"lastSuccessfulTime": number,
"nextDeliveryTime": number
},
"configStreamDeliveryInfo": {
"lastErrorCode": "string",
"lastErrorMessage": "string",
"lastStatus": "string",
"lastStatusChangeTime": number
},
"name": "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.
- DeliveryChannelsStatus
-
A list that contains the status of a specified delivery channel.
Type: Array of DeliveryChannelStatus objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchDeliveryChannelException
-
You have specified a delivery channel that does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
