Cookie の設定を選択する

当社は、当社のサイトおよびサービスを提供するために必要な必須 Cookie および類似のツールを使用しています。当社は、パフォーマンス Cookie を使用して匿名の統計情報を収集することで、お客様が当社のサイトをどのように利用しているかを把握し、改善に役立てています。必須 Cookie は無効化できませんが、[カスタマイズ] または [拒否] をクリックしてパフォーマンス Cookie を拒否することはできます。

お客様が同意した場合、AWS および承認された第三者は、Cookie を使用して便利なサイト機能を提供したり、お客様の選択を記憶したり、関連する広告を含む関連コンテンツを表示したりします。すべての必須ではない Cookie を受け入れるか拒否するには、[受け入れる] または [拒否] をクリックしてください。より詳細な選択を行うには、[カスタマイズ] をクリックしてください。

ListContacts - Amazon Simple Email Service
このページはお客様の言語に翻訳されていません。 翻訳のリクエスト

ListContacts

Lists the contacts present in a specific contact list.

Request Syntax

POST /v2/email/contact-lists/ContactListName/contacts/list HTTP/1.1 Content-type: application/json { "Filter": { "FilteredStatus": "string", "TopicFilter": { "TopicName": "string", "UseDefaultIfPreferenceUnavailable": boolean } }, "NextToken": "string", "PageSize": number }

URI Request Parameters

The request uses the following URI parameters.

ContactListName

The name of the contact list.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Filter

A filter that can be applied to a list of contacts.

Type: ListContactsFilter object

Required: No

NextToken

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Type: String

Required: No

PageSize

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

Type: Integer

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Contacts": [ { "EmailAddress": "string", "LastUpdatedTimestamp": number, "TopicDefaultPreferences": [ { "SubscriptionStatus": "string", "TopicName": "string" } ], "TopicPreferences": [ { "SubscriptionStatus": "string", "TopicName": "string" } ], "UnsubscribeAll": boolean } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Contacts

The contacts present in a specific contact list.

Type: Array of Contact objects

NextToken

A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

プライバシーサイト規約Cookie の設定
© 2025, Amazon Web Services, Inc. or its affiliates.All rights reserved.