ConfigureLogsForPlaybackConfiguration
Defines where AWS Elemental MediaTailor sends logs for the playback configuration.
Request Syntax
PUT /configureLogs/playbackConfiguration HTTP/1.1
Content-type: application/json
{
"EnabledLoggingStrategies": [ "string
" ],
"PercentEnabled": number
,
"PlaybackConfigurationName": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- EnabledLoggingStrategies
-
The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose
LEGACY_CLOUDWATCH
. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, chooseVENDED_LOGS
. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in Enable logging from AWS services, Logging that requires additional permissions [V2].
Type: Array of strings
Valid Values:
VENDED_LOGS | LEGACY_CLOUDWATCH
Required: No
- PercentEnabled
-
The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to
60
, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.Valid values:
0
-100
Type: Integer
Required: Yes
- PlaybackConfigurationName
-
The name of the playback configuration.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EnabledLoggingStrategies": [ "string" ],
"PercentEnabled": number,
"PlaybackConfigurationName": "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.
- EnabledLoggingStrategies
-
The method used for collecting logs from AWS Elemental MediaTailor.
LEGACY_CLOUDWATCH
indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs.VENDED_LOGS
indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.Type: Array of strings
Valid Values:
VENDED_LOGS | LEGACY_CLOUDWATCH
- PercentEnabled
-
The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.
Type: Integer
- PlaybackConfigurationName
-
The name of the playback configuration.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: