delete_contact_method `async` ¶

delete_contact_method(
    protocol: ContactProtocol,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> DeleteContactMethodResult

Deletes a contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

Parameters:

protocol (ContactProtocol) –

The protocol that will be deleted, such as Email or SMS (text messaging).

To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException –

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
OperationFailureException –

Lightsail throws this exception when an operation fails to execute.
RegionSetupInProgressException –

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/async_lightsail.py

async def delete_contact_method(
    self,
    protocol: "capo_lightsail.types.contact_protocol.ContactProtocol",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> "capo_lightsail.types.delete_contact_method_result.DeleteContactMethodResult":
    """<p>Deletes a contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications">Notifications in Amazon Lightsail</a>.</p>

    Args:
        protocol: <p>The protocol that will be deleted, such as <code>Email</code> or <code>SMS</code> (text messaging).</p> <note> <p>To delete an <code>Email</code> and an <code>SMS</code> contact method if you added both, you must run separate <code>DeleteContactMethod</code> actions to delete each protocol.</p> </note>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.delete_contact_method_request.DeleteContactMethodRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.delete_contact_method_result.DeleteContactMethodResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.delete_contact_method

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.delete_contact_method.async_delete_contact_method(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteContactMethod")
    )
    input_: capo_lightsail.types.delete_contact_method_request.DeleteContactMethodRequest = {
        "protocol": protocol
    }

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

delete_contact_method async ¶

delete_contact_method `async` ¶