AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetSegments and EndGetSegments.

Namespace: Amazon.Pinpoint
Assembly: AWSSDK.Pinpoint.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<GetSegmentsResponse> GetSegmentsAsync(
         GetSegmentsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Pinpoint.Model.GetSegmentsRequest

Container for the necessary parameters to execute the GetSegments service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetSegments service method, as returned by Pinpoint.

Exceptions

ExceptionCondition
BadRequestException Provides information about an API request or response.
ForbiddenException Provides information about an API request or response.
InternalServerErrorException Provides information about an API request or response.
MethodNotAllowedException Provides information about an API request or response.
NotFoundException Provides information about an API request or response.
PayloadTooLargeException Provides information about an API request or response.
TooManyRequestsException Provides information about an API request or response.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also