Describe Protect Configurations

pinpointsmsvoicev2_describe_protect_configurations

R Documentation

Retrieves the protect configurations that match any of filters¶

Description¶

Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

Usage¶

pinpointsmsvoicev2_describe_protect_configurations(
  ProtectConfigurationIds, Filters, NextToken, MaxResults)

Arguments¶

ProtectConfigurationIds: An array of protect configuration identifiers to search for.
Filters: An array of ProtectConfigurationFilter 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.

Value¶

A list with the following syntax:

list(
  ProtectConfigurations = list(
    list(
      ProtectConfigurationArn = "string",
      ProtectConfigurationId = "string",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      AccountDefault = TRUE|FALSE,
      DeletionProtectionEnabled = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_protect_configurations(
  ProtectConfigurationIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "account-default"|"deletion-protection-enabled",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)