listScenes method

Future<ListScenesResponse> listScenes({
  1. required String workspaceId,
  2. int? maxResults,
  3. String? nextToken,
})

Lists all scenes in a workspace.

May throw AccessDeniedException. May throw InternalServerException. May throw ThrottlingException. May throw ValidationException.

Parameter workspaceId : The ID of the workspace that contains the scenes.

Parameter maxResults : Specifies the maximum number of results to display.

Parameter nextToken : The string that specifies the next page of results.

Implementation

Future<ListScenesResponse> listScenes({
  required String workspaceId,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    0,
    200,
  );
  final $payload = <String, dynamic>{
    if (maxResults != null) 'maxResults': maxResults,
    if (nextToken != null) 'nextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/workspaces/${Uri.encodeComponent(workspaceId)}/scenes-list',
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return ListScenesResponse.fromJson(response);
}