Describe Configuration Sets
pinpointsmsvoicev2_describe_configuration_sets | R Documentation |
Describes the specified configuration sets or all in your account¶
Description¶
Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
Usage¶
pinpointsmsvoicev2_describe_configuration_sets(ConfigurationSetNames,
Filters, NextToken, MaxResults)
Arguments¶
ConfigurationSetNames
An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
Filters
An array of filters to apply to the results that are returned.
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.
Value¶
A list with the following syntax:
list(
ConfigurationSets = list(
list(
ConfigurationSetArn = "string",
ConfigurationSetName = "string",
EventDestinations = list(
list(
EventDestinationName = "string",
Enabled = TRUE|FALSE,
MatchingEventTypes = list(
"ALL"|"TEXT_ALL"|"TEXT_SENT"|"TEXT_PENDING"|"TEXT_QUEUED"|"TEXT_SUCCESSFUL"|"TEXT_DELIVERED"|"TEXT_INVALID"|"TEXT_INVALID_MESSAGE"|"TEXT_UNREACHABLE"|"TEXT_CARRIER_UNREACHABLE"|"TEXT_BLOCKED"|"TEXT_CARRIER_BLOCKED"|"TEXT_SPAM"|"TEXT_UNKNOWN"|"TEXT_TTL_EXPIRED"|"VOICE_ALL"|"VOICE_INITIATED"|"VOICE_RINGING"|"VOICE_ANSWERED"|"VOICE_COMPLETED"|"VOICE_BUSY"|"VOICE_NO_ANSWER"|"VOICE_FAILED"|"VOICE_TTL_EXPIRED"|"MEDIA_ALL"|"MEDIA_PENDING"|"MEDIA_QUEUED"|"MEDIA_SUCCESSFUL"|"MEDIA_DELIVERED"|"MEDIA_INVALID"|"MEDIA_INVALID_MESSAGE"|"MEDIA_UNREACHABLE"|"MEDIA_CARRIER_UNREACHABLE"|"MEDIA_BLOCKED"|"MEDIA_CARRIER_BLOCKED"|"MEDIA_SPAM"|"MEDIA_UNKNOWN"|"MEDIA_TTL_EXPIRED"|"MEDIA_FILE_INACCESSIBLE"|"MEDIA_FILE_TYPE_UNSUPPORTED"|"MEDIA_FILE_SIZE_EXCEEDED"
),
CloudWatchLogsDestination = list(
IamRoleArn = "string",
LogGroupArn = "string"
),
KinesisFirehoseDestination = list(
IamRoleArn = "string",
DeliveryStreamArn = "string"
),
SnsDestination = list(
TopicArn = "string"
)
)
),
DefaultMessageType = "TRANSACTIONAL"|"PROMOTIONAL",
DefaultSenderId = "string",
CreatedTimestamp = as.POSIXct(
"2015-01-01"
),
ProtectConfigurationId = "string"
)
),
NextToken = "string"
)