PinpointSMSVoiceV2 / Client / delete_registration_field_value

delete_registration_field_value#

PinpointSMSVoiceV2.Client.delete_registration_field_value(**kwargs)#

Delete the value in a registration form field.

Request Syntax

response = client.delete_registration_field_value(
    RegistrationId='string',
    FieldPath='string'
)

Parameters:

RegistrationId (string) –
[REQUIRED]

The unique identifier for the registration.
FieldPath (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'VersionNumber': 123,
    'FieldPath': 'string',
    'SelectChoices': [
        'string',
    ],
    'TextValue': 'string',
    'RegistrationAttachmentId': '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 version number of the registration.
- FieldPath (string) –
  
  The path to the registration form field.
- 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.

Exceptions

PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.ConflictException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException