describeSchedule method

Future<DescribeScheduleResponse> describeSchedule({
  1. required String channelId,
  2. int? maxResults,
  3. String? nextToken,
})

Get a channel schedule

May throw BadRequestException. May throw InternalServerErrorException. May throw ForbiddenException. May throw BadGatewayException. May throw NotFoundException. May throw GatewayTimeoutException. May throw TooManyRequestsException.

Parameter channelId : Id of the channel whose schedule is being updated.

Implementation

Future<DescribeScheduleResponse> describeSchedule({
  required String channelId,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(channelId, 'channelId');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/prod/channels/${Uri.encodeComponent(channelId)}/schedule',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeScheduleResponse.fromJson(response);
}