PinpointSMSVoiceV2 / Client / describe_registration_field_values

describe_registration_field_values#

PinpointSMSVoiceV2.Client.describe_registration_field_values(**kwargs)#

Retrieves the specified registration field values.

See also: AWS API Documentation

Request Syntax

response = client.describe_registration_field_values(
    RegistrationId='string',
    VersionNumber=123,
    SectionPath='string',
    FieldPaths=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • RegistrationId (string) –

    [REQUIRED]

    The unique identifier for the registration.

  • VersionNumber (integer) – The version number of the registration.

  • SectionPath (string) – The path to the section of the registration.

  • FieldPaths (list) –

    An array of paths to the registration form field.

    • (string) –

  • NextToken (string) – 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 (integer) – The maximum number of results to return per each request.

Return type:

dict

Returns:

Response Syntax

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'VersionNumber': 123,
    'RegistrationFieldValues': [
        {
            'FieldPath': 'string',
            'SelectChoices': [
                'string',
            ],
            'TextValue': 'string',
            'RegistrationAttachmentId': 'string',
            'DeniedReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RegistrationArn (string) –

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId (string) –

      The unique identifier for the registration.

    • VersionNumber (integer) –

      The current version of the registration.

    • RegistrationFieldValues (list) –

      An array of RegistrationFieldValues objects that contain the values for the requested registration.

      • (dict) –

        Provides the values of the specified field.

        • FieldPath (string) –

          The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

        • SelectChoices (list) –

          An array of values for the form field.

          • (string) –

        • TextValue (string) –

          The text data for a free form field.

        • RegistrationAttachmentId (string) –

          The unique identifier for the registration attachment.

        • DeniedReason (string) –

          A description of why the registration was denied.

    • NextToken (string) –

      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.

Exceptions

  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

  • PinpointSMSVoiceV2.Client.exceptions.ValidationException

  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException