getSegments method

Future<GetSegmentsResponse> getSegments({ required String applicationId, String? pageSize, String? token, })

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

May throw BadRequestException. May throw InternalServerErrorException. May throw PayloadTooLargeException. May throw ForbiddenException. May throw NotFoundException. May throw MethodNotAllowedException. May throw TooManyRequestsException.

Parameter applicationId : The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Parameter pageSize : The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Parameter token : The NextToken string that specifies which page of results to return in a paginated response.

Implementation

Future<GetSegmentsResponse> getSegments({
  required String applicationId,
  String? pageSize,
  String? token,
}) async {
  ArgumentError.checkNotNull(applicationId, 'applicationId');
  final $query = <String, List<String>>{
    if (pageSize != null) 'page-size': [pageSize],
    if (token != null) 'token': [token],
  };
  final response = await _protocol.sendRaw(
    payload: null,
    method: 'GET',
    requestUri: '/v1/apps/${Uri.encodeComponent(applicationId)}/segments',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  final $json = await _s.jsonFromResponse(response);
  return GetSegmentsResponse(
    segmentsResponse: SegmentsResponse.fromJson($json),
  );
}