Skip to content

Describe Registrations

pinpointsmsvoicev2_describe_registrations R Documentation

Retrieves the specified registrations

Description

Retrieves the specified registrations.

Usage

pinpointsmsvoicev2_describe_registrations(RegistrationIds, Filters,
  NextToken, MaxResults)

Arguments

RegistrationIds

An array of unique identifiers for each registration.

Filters

An array of RegistrationFilter 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(
  Registrations = list(
    list(
      RegistrationArn = "string",
      RegistrationId = "string",
      RegistrationType = "string",
      RegistrationStatus = "CREATED"|"SUBMITTED"|"REVIEWING"|"PROVISIONING"|"COMPLETE"|"REQUIRES_UPDATES"|"CLOSED"|"DELETED",
      CurrentVersionNumber = 123,
      ApprovedVersionNumber = 123,
      LatestDeniedVersionNumber = 123,
      AdditionalAttributes = list(
        "string"
      ),
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_registrations(
  RegistrationIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "registration-type"|"registration-status",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)