Describe Sender Ids

pinpointsmsvoicev2_describe_sender_ids

R Documentation

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account¶

Description¶

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn't valid, an error is returned.

Usage¶

pinpointsmsvoicev2_describe_sender_ids(SenderIds, Filters, NextToken,
  MaxResults, Owner)

Arguments¶

SenderIds

An array of SenderIdAndCountry objects to search for.

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

Filters

An array of SenderIdFilter objects to filter the results.

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.

MaxResults

The maximum number of results to return per each request.

Owner

Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

Value¶

A list with the following syntax:

list(
  SenderIds = list(
    list(
      SenderIdArn = "string",
      SenderId = "string",
      IsoCountryCode = "string",
      MessageTypes = list(
        "TRANSACTIONAL"|"PROMOTIONAL"
      ),
      MonthlyLeasingPrice = "string",
      DeletionProtectionEnabled = TRUE|FALSE,
      Registered = TRUE|FALSE,
      RegistrationId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_sender_ids(
  SenderIds = list(
    list(
      SenderId = "string",
      IsoCountryCode = "string"
    )
  ),
  Filters = list(
    list(
      Name = "sender-id"|"iso-country-code"|"message-type"|"deletion-protection-enabled"|"registered",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123,
  Owner = "SELF"|"SHARED"
)