updatePipelineNotifications method
Future<UpdatePipelineNotificationsResponse>
updatePipelineNotifications({
- required String id,
- required Notifications notifications,
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.
When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.
May throw ValidationException. May throw IncompatibleVersionException. May throw ResourceNotFoundException. May throw ResourceInUseException. May throw AccessDeniedException. May throw InternalServiceException.
Parameter id
:
The identifier of the pipeline for which you want to change notification
settings.
Parameter notifications
:
The topic ARN for the Amazon Simple Notification Service (Amazon SNS)
topic that you want to notify to report job status.
- Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
- Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
- Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
- Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.
Implementation
Future<UpdatePipelineNotificationsResponse> updatePipelineNotifications({
required String id,
required Notifications notifications,
}) async {
ArgumentError.checkNotNull(id, 'id');
ArgumentError.checkNotNull(notifications, 'notifications');
final $payload = <String, dynamic>{
'Notifications': notifications,
};
final response = await _protocol.send(
payload: $payload,
method: 'POST',
requestUri:
'/2012-09-25/pipelines/${Uri.encodeComponent(id)}/notifications',
exceptionFnMap: _exceptionFns,
);
return UpdatePipelineNotificationsResponse.fromJson(response);
}