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.

Container for the parameters to the DescribeOptOutLists operation. Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an error is returned.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.PinpointSMSVoiceV2.AmazonPinpointSMSVoiceV2Request
      Amazon.PinpointSMSVoiceV2.Model.DescribeOptOutListsRequest

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

Syntax

C#
public class DescribeOptOutListsRequest : AmazonPinpointSMSVoiceV2Request
         IAmazonWebServiceRequest

The DescribeOptOutListsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of results to return per each request.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Public Property OptOutListNames System.Collections.Generic.List<System.String>

Gets and sets the property OptOutListNames.

The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Public Property Owner Amazon.PinpointSMSVoiceV2.Owner

Gets and sets the property Owner.

Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5