Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DescribeOptOutListsCommand

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.

example

Use a bare-bones client and the command you need to make an API call.

import { PinpointSMSVoiceV2Client, DescribeOptOutListsCommand } from "@aws-sdk/client-pinpoint-sms-voice-v2"; // ES Modules import
// const { PinpointSMSVoiceV2Client, DescribeOptOutListsCommand } = require("@aws-sdk/client-pinpoint-sms-voice-v2"); // CommonJS import
const client = new PinpointSMSVoiceV2Client(config);
const command = new DescribeOptOutListsCommand(input);
const response = await client.send(command);
see

DescribeOptOutListsCommandInput for command's input shape.

see

DescribeOptOutListsCommandOutput for command's response shape.

see

config for PinpointSMSVoiceV2Client's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: DescribeOptOutListsCommandInput

Readonly middlewareStack