Skip to content

put_registration_field_value

put_registration_field_value(
    registration_id: RegistrationIdOrArn,
    field_path: FieldPath,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    select_choices: Optional[SelectChoiceList] = None,
    text_value: Optional[TextValue] = None,
    registration_attachment_id: Optional[RegistrationAttachmentIdOrArn] = None,
) -> PutRegistrationFieldValueResult

Creates or updates a field value for a registration.

Parameters:

Raises:

  • AccessDeniedException –

    The request was denied because you don't have sufficient permissions to access the resource.

  • ConflictException –

    Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

  • InternalServerException –

    The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

  • ResourceNotFoundException –

    A requested resource couldn't be found.

  • ThrottlingException –

    An error that occurred because too many requests were sent during a certain amount of time.

  • ValidationException –

    A validation exception for a field.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py
def put_registration_field_value(
    self,
    registration_id: "capo_pinpoint_sms_voice_v2.types.registration_id_or_arn.RegistrationIdOrArn",
    field_path: "capo_pinpoint_sms_voice_v2.types.field_path.FieldPath",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    select_choices: Optional[
        "capo_pinpoint_sms_voice_v2.types.select_choice_list.SelectChoiceList"
    ] = None,
    text_value: Optional[
        "capo_pinpoint_sms_voice_v2.types.text_value.TextValue"
    ] = None,
    registration_attachment_id: Optional[
        "capo_pinpoint_sms_voice_v2.types.registration_attachment_id_or_arn.RegistrationAttachmentIdOrArn"
    ] = None,
) -> "capo_pinpoint_sms_voice_v2.types.put_registration_field_value_result.PutRegistrationFieldValueResult":
    """<p>Creates or updates a field value for a registration.</p>

    Args:
        registration_id: <p>The unique identifier for the registration.</p>
        field_path: <p>The path to the registration form field. You can use <a>DescribeRegistrationFieldDefinitions</a> for a list of <b>FieldPaths</b>.</p>
        select_choices: <p>An array of values for the form field.</p>
        text_value: <p>The text data for a free form field.</p>
        registration_attachment_id: <p>The unique identifier for the registration attachment.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.conflict_exception.ConflictException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.put_registration_field_value_request.PutRegistrationFieldValueRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.put_registration_field_value_result.PutRegistrationFieldValueResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.put_registration_field_value

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.put_registration_field_value.put_registration_field_value(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutRegistrationFieldValue")
    )
    input_: capo_pinpoint_sms_voice_v2.types.put_registration_field_value_request.PutRegistrationFieldValueRequest = {
        "registration_id": registration_id,
        "field_path": field_path,
    }
    if select_choices is not None:
        input_["select_choices"] = select_choices
    if text_value is not None:
        input_["text_value"] = text_value
    if registration_attachment_id is not None:
        input_["registration_attachment_id"] = registration_attachment_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output