Skip to content

CreateRegistrationResult

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/create_registration_result.py
class CreateRegistrationResult(TypedDict, closed=True):
    registration_arn: "str"
    """<p>The Amazon Resource Name (ARN) for the registration.</p>"""
    registration_id: "str"
    """<p>The unique identifier for the registration.</p>"""
    registration_type: (
        "capo_pinpoint_sms_voice_v2.types.registration_type.RegistrationType"
    )
    """<p>The type of registration form to create. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.</p>"""
    registration_status: (
        "capo_pinpoint_sms_voice_v2.types.registration_status.RegistrationStatus"
    )
    """<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: "capo_pinpoint_sms_voice_v2.types.registration_version_number.RegistrationVersionNumber"
    """<p>The current version number of the registration.</p>"""
    additional_attributes: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.string_map.StringMap"
    ]
    """<p>Metadata about a given registration which is specific to that registration type.</p>"""
    tags: NotRequired["capo_pinpoint_sms_voice_v2.types.tag_list.TagList"]
    """<p>An array of tags (key and value pairs) to associate with the registration.</p>"""
    created_timestamp: "datetime.datetime"
    """<p>The time when the registration was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>"""

additional_attributes instance-attribute

additional_attributes: NotRequired[StringMap]

Metadata about a given registration which is specific to that registration type.

created_timestamp instance-attribute

created_timestamp: datetime

The time when the registration was created, in UNIX epoch time format.

current_version_number instance-attribute

current_version_number: RegistrationVersionNumber

The current version number of the registration.

registration_arn instance-attribute

registration_arn: str

The Amazon Resource Name (ARN) for the registration.

registration_id instance-attribute

registration_id: str

The unique identifier for the registration.

registration_status instance-attribute

registration_status: RegistrationStatus

The status of the registration.

  • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

  • CREATED: Your registration is created but not submitted.

  • COMPLETE: Your registration has been approved and your origination identity has been created.

  • DELETED: The registration has been deleted.

  • PROVISIONING: Your registration has been approved and your origination identity is being created.

  • REQUIRES_AUTHENTICATION: You need to complete email authentication.

  • REQUIRES_UPDATES: You must fix your registration and resubmit it.

  • REVIEWING: Your registration has been accepted and is being reviewed.

  • SUBMITTED: Your registration has been submitted and is awaiting review.

registration_type instance-attribute

registration_type: RegistrationType

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

tags instance-attribute

tags: NotRequired[TagList]

An array of tags (key and value pairs) to associate with the registration.