create_registration ¶

create_registration(
    registration_type: RegistrationType,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    tags: Optional[TagList] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateRegistrationResult

Creates a new registration based on the RegistrationType field.

Parameters:

registration_type (RegistrationType) –

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
tags (Optional[TagList], default: None ) –

An array of tags (key and value pairs) to associate with the registration.
client_token (Optional[ClientToken], default: None ) –

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

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.
ServiceQuotaExceededException –

The request would cause a service quota to be exceeded.
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 create_registration(
    self,
    registration_type: "capo_pinpoint_sms_voice_v2.types.registration_type.RegistrationType",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    tags: Optional["capo_pinpoint_sms_voice_v2.types.tag_list.TagList"] = None,
    client_token: Optional[
        "capo_pinpoint_sms_voice_v2.types.client_token.ClientToken"
    ] = None,
) -> "capo_pinpoint_sms_voice_v2.types.create_registration_result.CreateRegistrationResult":
    """<p>Creates a new registration based on the <b>RegistrationType</b> field. </p>

    Args:
        registration_type: <p>The type of registration form to create. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.</p>
        tags: <p>An array of tags (key and value pairs) to associate with the registration.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded.</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.create_registration_request.CreateRegistrationRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.create_registration_result.CreateRegistrationResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.create_registration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRegistration")
    )
    input_: capo_pinpoint_sms_voice_v2.types.create_registration_request.CreateRegistrationRequest = {
        "registration_type": registration_type
    }
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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