aws_sdk_pinpointsmsvoicev2/client/

create_registration.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateRegistration`](crate::operation::create_registration::builders::CreateRegistrationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`registration_type(impl Into<String>)`](crate::operation::create_registration::builders::CreateRegistrationFluentBuilder::registration_type) / [`set_registration_type(Option<String>)`](crate::operation::create_registration::builders::CreateRegistrationFluentBuilder::set_registration_type):<br>required: **true**<br><p>The type of registration form to create. The list of <b>RegistrationTypes</b> can be found using the <code>DescribeRegistrationTypeDefinitions</code> action.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_registration::builders::CreateRegistrationFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_registration::builders::CreateRegistrationFluentBuilder::set_tags):<br>required: **false**<br><p>An array of tags (key and value pairs) to associate with the registration.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_registration::builders::CreateRegistrationFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_registration::builders::CreateRegistrationFluentBuilder::set_client_token):<br>required: **false**<br><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><br>
    /// - On success, responds with [`CreateRegistrationOutput`](crate::operation::create_registration::CreateRegistrationOutput) with field(s):
    ///   - [`registration_arn(String)`](crate::operation::create_registration::CreateRegistrationOutput::registration_arn): <p>The Amazon Resource Name (ARN) for the registration.</p>
    ///   - [`registration_id(String)`](crate::operation::create_registration::CreateRegistrationOutput::registration_id): <p>The unique identifier for the registration.</p>
    ///   - [`registration_type(String)`](crate::operation::create_registration::CreateRegistrationOutput::registration_type): <p>The type of registration form to create. The list of <b>RegistrationTypes</b> can be found using the <code>DescribeRegistrationTypeDefinitions</code> action.</p>
    ///   - [`registration_status(RegistrationStatus)`](crate::operation::create_registration::CreateRegistrationOutput::registration_status): <p>The status of the registration.</p> <ul>  <li>   <p><code>CLOSED</code>: The phone number or sender ID has been deleted and you must also delete the registration for the number.</p></li>  <li>   <p><code>CREATED</code>: Your registration is created but not submitted.</p></li>  <li>   <p><code>COMPLETE</code>: Your registration has been approved and your origination identity has been created.</p></li>  <li>   <p><code>DELETED</code>: The registration has been deleted.</p></li>  <li>   <p><code>PROVISIONING</code>: Your registration has been approved and your origination identity is being created.</p></li>  <li>   <p><code>REQUIRES_AUTHENTICATION</code>: You need to complete email authentication.</p></li>  <li>   <p><code>REQUIRES_UPDATES</code>: You must fix your registration and resubmit it.</p></li>  <li>   <p><code>REVIEWING</code>: Your registration has been accepted and is being reviewed.</p></li>  <li>   <p><code>SUBMITTED</code>: Your registration has been submitted and is awaiting review.</p></li> </ul>
    ///   - [`current_version_number(i64)`](crate::operation::create_registration::CreateRegistrationOutput::current_version_number): <p>The current version number of the registration.</p>
    ///   - [`additional_attributes(Option<HashMap::<String, String>>)`](crate::operation::create_registration::CreateRegistrationOutput::additional_attributes): <p>Metadata about a given registration which is specific to that registration type.</p>
    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::create_registration::CreateRegistrationOutput::tags): <p>An array of tags (key and value pairs) to associate with the registration.</p>
    ///   - [`created_timestamp(DateTime)`](crate::operation::create_registration::CreateRegistrationOutput::created_timestamp): <p>The time when the registration was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    /// - On failure, responds with [`SdkError<CreateRegistrationError>`](crate::operation::create_registration::CreateRegistrationError)
    pub fn create_registration(&self) -> crate::operation::create_registration::builders::CreateRegistrationFluentBuilder {
        crate::operation::create_registration::builders::CreateRegistrationFluentBuilder::new(self.handle.clone())
    }
}