Skip to content

UserNotificationsContactsClient#

Index > UserNotificationsContacts > UserNotificationsContactsClient

Auto-generated documentation for UserNotificationsContacts type annotations stubs module mypy-boto3-notificationscontacts.

UserNotificationsContactsClient#

Type annotations and code completion for boto3.client("notificationscontacts"). boto3 documentation

# UserNotificationsContactsClient usage example

from boto3.session import Session
from mypy_boto3_notificationscontacts.client import UserNotificationsContactsClient

def get_notificationscontacts_client() -> UserNotificationsContactsClient:
    return Session().client("notificationscontacts")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("notificationscontacts").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("notificationscontacts")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_notificationscontacts.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

activate_email_contact#

Activates an email contact using an activation code.

Type annotations and code completion for boto3.client("notificationscontacts").activate_email_contact method. boto3 documentation

# activate_email_contact method definition

def activate_email_contact(
    self,
    *,
    arn: str,
    code: str,
) -> Dict[str, Any]:
    ...
# activate_email_contact method usage example with argument unpacking

kwargs: ActivateEmailContactRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "code": ...,
}

parent.activate_email_contact(**kwargs)
  1. See ActivateEmailContactRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("notificationscontacts").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("notificationscontacts").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_email_contact#

Creates an email contact for the provided email address.

Type annotations and code completion for boto3.client("notificationscontacts").create_email_contact method. boto3 documentation

# create_email_contact method definition

def create_email_contact(
    self,
    *,
    name: str,
    emailAddress: str,
    tags: Mapping[str, str] = ...,
) -> CreateEmailContactResponseTypeDef:  # (1)
    ...
  1. See CreateEmailContactResponseTypeDef 
# create_email_contact method usage example with argument unpacking

kwargs: CreateEmailContactRequestRequestTypeDef = {  # (1)
    "name": ...,
    "emailAddress": ...,
}

parent.create_email_contact(**kwargs)
  1. See CreateEmailContactRequestRequestTypeDef

delete_email_contact#

Deletes an email contact.

Type annotations and code completion for boto3.client("notificationscontacts").delete_email_contact method. boto3 documentation

# delete_email_contact method definition

def delete_email_contact(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...
# delete_email_contact method usage example with argument unpacking

kwargs: DeleteEmailContactRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_email_contact(**kwargs)
  1. See DeleteEmailContactRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("notificationscontacts").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_email_contact#

Returns an email contact.

Type annotations and code completion for boto3.client("notificationscontacts").get_email_contact method. boto3 documentation

# get_email_contact method definition

def get_email_contact(
    self,
    *,
    arn: str,
) -> GetEmailContactResponseTypeDef:  # (1)
    ...
  1. See GetEmailContactResponseTypeDef 
# get_email_contact method usage example with argument unpacking

kwargs: GetEmailContactRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_email_contact(**kwargs)
  1. See GetEmailContactRequestRequestTypeDef

list_email_contacts#

Lists all email contacts created under the Account.

Type annotations and code completion for boto3.client("notificationscontacts").list_email_contacts method. boto3 documentation

# list_email_contacts method definition

def list_email_contacts(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEmailContactsResponseTypeDef:  # (1)
    ...
  1. See ListEmailContactsResponseTypeDef 
# list_email_contacts method usage example with argument unpacking

kwargs: ListEmailContactsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_email_contacts(**kwargs)
  1. See ListEmailContactsRequestRequestTypeDef

list_tags_for_resource#

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.

Type annotations and code completion for boto3.client("notificationscontacts").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

send_activation_code#

Sends an activation email to the email address associated with the specified email contact.

Type annotations and code completion for boto3.client("notificationscontacts").send_activation_code method. boto3 documentation

# send_activation_code method definition

def send_activation_code(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...
# send_activation_code method usage example with argument unpacking

kwargs: SendActivationCodeRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.send_activation_code(**kwargs)
  1. See SendActivationCodeRequestRequestTypeDef

tag_resource#

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).

Type annotations and code completion for boto3.client("notificationscontacts").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    arn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).

Type annotations and code completion for boto3.client("notificationscontacts").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    arn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("notificationscontacts").get_paginator method with overloads.