Skip to content

ContactMethod

Source code in docs_src/capo_lightsail/types/contact_method.py
class ContactMethod(TypedDict, closed=True):
    contact_endpoint: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The destination of the contact method, such as an email address or a mobile phone number.</p>"""
    status: NotRequired[
        "capo_lightsail.types.contact_method_status.ContactMethodStatus"
    ]
    """<p>The current status of the contact method.</p> <p>A contact method has the following possible status:</p> <ul> <li> <p> <code>PendingVerification</code> - The contact method has not yet been verified, and the verification has not yet expired.</p> </li> <li> <p> <code>Valid</code> - The contact method has been verified.</p> </li> <li> <p> <code>InValid</code> - An attempt was made to verify the contact method, but the verification has expired.</p> </li> </ul>"""
    protocol: NotRequired["capo_lightsail.types.contact_protocol.ContactProtocol"]
    """<p>The protocol of the contact method, such as email or SMS (text messaging).</p>"""
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the contact method.</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the contact method.</p>"""
    created_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the contact method was created.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The Lightsail resource type of the contact method.</p>"""
    support_code: NotRequired["capo_lightsail.types.string.string"]
    """<p>The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.</p>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the contact method.

contact_endpoint instance-attribute

contact_endpoint: NotRequired[NonEmptyString]

The destination of the contact method, such as an email address or a mobile phone number.

created_at instance-attribute

created_at: NotRequired[IsoDate]

The timestamp when the contact method was created.

location instance-attribute

location: NotRequired[ResourceLocation]

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

name instance-attribute

name: NotRequired[ResourceName]

The name of the contact method.

protocol instance-attribute

protocol: NotRequired[ContactProtocol]

The protocol of the contact method, such as email or SMS (text messaging).

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The Lightsail resource type of the contact method.

status instance-attribute

status: NotRequired[ContactMethodStatus]

The current status of the contact method.

A contact method has the following possible status:

  • PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.

  • Valid - The contact method has been verified.

  • InValid - An attempt was made to verify the contact method, but the verification has expired.

support_code instance-attribute

support_code: NotRequired[string]

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

tags instance-attribute

tags: NotRequired[TagList]

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.