delete_registration_field_value `async` ¶

delete_registration_field_value(
    registration_id: RegistrationIdOrArn,
    field_path: FieldPath,
    *,
    config_overrides: Optional[AsyncPinpointSMSVoiceV2ClientConfig] = None,
) -> DeleteRegistrationFieldValueResult

Delete the value in a registration form field.

Parameters:

registration_id (RegistrationIdOrArn) –

The unique identifier for the registration.
field_path (FieldPath) –

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

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/async_pinpoint_sms_voice_v2.py

async def delete_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[AsyncPinpointSMSVoiceV2ClientConfig] = None,
) -> "capo_pinpoint_sms_voice_v2.types.delete_registration_field_value_result.DeleteRegistrationFieldValueResult":
    """<p>Delete the value in a registration form field.</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>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint_sms_voice_v2.types.delete_registration_field_value_request.DeleteRegistrationFieldValueRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint_sms_voice_v2.types.delete_registration_field_value_result.DeleteRegistrationFieldValueResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.delete_registration_field_value

        (
            output,
            http_response,
        ) = await capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.delete_registration_field_value.async_delete_registration_field_value(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRegistrationFieldValue")
    )
    input_: capo_pinpoint_sms_voice_v2.types.delete_registration_field_value_request.DeleteRegistrationFieldValueRequest = {
        "registration_id": registration_id,
        "field_path": field_path,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_registration_field_value async ¶

delete_registration_field_value `async` ¶