Skip to content

SSMContactsClient#

Index > SSMContacts > SSMContactsClient

Auto-generated documentation for SSMContacts type annotations stubs module mypy-boto3-ssm-contacts.

SSMContactsClient#

Type annotations and code completion for boto3.client("ssm-contacts"). boto3 documentation

# SSMContactsClient usage example

from boto3.session import Session
from mypy_boto3_ssm_contacts.client import SSMContactsClient

def get_ssm-contacts_client() -> SSMContactsClient:
    return Session().client("ssm-contacts")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("ssm-contacts")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.DataEncryptionException,
    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_ssm_contacts.client import Exceptions

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

Methods#

accept_page#

Used to acknowledge an engagement to a contact channel during an incident.

Type annotations and code completion for boto3.client("ssm-contacts").accept_page method. boto3 documentation

# accept_page method definition

def accept_page(
    self,
    *,
    PageId: str,
    AcceptType: AcceptTypeType,  # (1)
    AcceptCode: str,
    ContactChannelId: str = ...,
    Note: str = ...,
    AcceptCodeValidation: AcceptCodeValidationType = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See AcceptTypeType
  2. See AcceptCodeValidationType
# accept_page method usage example with argument unpacking

kwargs: AcceptPageRequestRequestTypeDef = {  # (1)
    "PageId": ...,
    "AcceptType": ...,
    "AcceptCode": ...,
}

parent.accept_page(**kwargs)
  1. See AcceptPageRequestRequestTypeDef

activate_contact_channel#

Activates a contact's contact channel.

Type annotations and code completion for boto3.client("ssm-contacts").activate_contact_channel method. boto3 documentation

# activate_contact_channel method definition

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

kwargs: ActivateContactChannelRequestRequestTypeDef = {  # (1)
    "ContactChannelId": ...,
    "ActivationCode": ...,
}

parent.activate_contact_channel(**kwargs)
  1. See ActivateContactChannelRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("ssm-contacts").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("ssm-contacts").close method. boto3 documentation

# close method definition

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

create_contact#

Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.

Type annotations and code completion for boto3.client("ssm-contacts").create_contact method. boto3 documentation

# create_contact method definition

def create_contact(
    self,
    *,
    Alias: str,
    Type: ContactTypeType,  # (1)
    Plan: PlanTypeDef,  # (2)
    DisplayName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    IdempotencyToken: str = ...,
) -> CreateContactResultTypeDef:  # (4)
    ...
  1. See ContactTypeType
  2. See PlanTypeDef
  3. See TagTypeDef
  4. See CreateContactResultTypeDef
# create_contact method usage example with argument unpacking

kwargs: CreateContactRequestRequestTypeDef = {  # (1)
    "Alias": ...,
    "Type": ...,
    "Plan": ...,
}

parent.create_contact(**kwargs)
  1. See CreateContactRequestRequestTypeDef

create_contact_channel#

A contact channel is the method that Incident Manager uses to engage your contact.

Type annotations and code completion for boto3.client("ssm-contacts").create_contact_channel method. boto3 documentation

# create_contact_channel method definition

def create_contact_channel(
    self,
    *,
    ContactId: str,
    Name: str,
    Type: ChannelTypeType,  # (1)
    DeliveryAddress: ContactChannelAddressTypeDef,  # (2)
    DeferActivation: bool = ...,
    IdempotencyToken: str = ...,
) -> CreateContactChannelResultTypeDef:  # (3)
    ...
  1. See ChannelTypeType
  2. See ContactChannelAddressTypeDef
  3. See CreateContactChannelResultTypeDef
# create_contact_channel method usage example with argument unpacking

kwargs: CreateContactChannelRequestRequestTypeDef = {  # (1)
    "ContactId": ...,
    "Name": ...,
    "Type": ...,
    "DeliveryAddress": ...,
}

parent.create_contact_channel(**kwargs)
  1. See CreateContactChannelRequestRequestTypeDef

create_rotation#

Creates a rotation in an on-call schedule.

Type annotations and code completion for boto3.client("ssm-contacts").create_rotation method. boto3 documentation

# create_rotation method definition

def create_rotation(
    self,
    *,
    Name: str,
    ContactIds: Sequence[str],
    TimeZoneId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    StartTime: Union[datetime, str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    IdempotencyToken: str = ...,
) -> CreateRotationResultTypeDef:  # (3)
    ...
  1. See RecurrenceSettingsTypeDef
  2. See TagTypeDef
  3. See CreateRotationResultTypeDef
# create_rotation method usage example with argument unpacking

kwargs: CreateRotationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ContactIds": ...,
    "TimeZoneId": ...,
    "Recurrence": ...,
}

parent.create_rotation(**kwargs)
  1. See CreateRotationRequestRequestTypeDef

create_rotation_override#

Creates an override for a rotation in an on-call schedule.

Type annotations and code completion for boto3.client("ssm-contacts").create_rotation_override method. boto3 documentation

# create_rotation_override method definition

def create_rotation_override(
    self,
    *,
    RotationId: str,
    NewContactIds: Sequence[str],
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    IdempotencyToken: str = ...,
) -> CreateRotationOverrideResultTypeDef:  # (1)
    ...
  1. See CreateRotationOverrideResultTypeDef
# create_rotation_override method usage example with argument unpacking

kwargs: CreateRotationOverrideRequestRequestTypeDef = {  # (1)
    "RotationId": ...,
    "NewContactIds": ...,
    "StartTime": ...,
    "EndTime": ...,
}

parent.create_rotation_override(**kwargs)
  1. See CreateRotationOverrideRequestRequestTypeDef

deactivate_contact_channel#

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

Type annotations and code completion for boto3.client("ssm-contacts").deactivate_contact_channel method. boto3 documentation

# deactivate_contact_channel method definition

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

kwargs: DeactivateContactChannelRequestRequestTypeDef = {  # (1)
    "ContactChannelId": ...,
}

parent.deactivate_contact_channel(**kwargs)
  1. See DeactivateContactChannelRequestRequestTypeDef

delete_contact#

To remove a contact from Incident Manager, you can delete the contact.

Type annotations and code completion for boto3.client("ssm-contacts").delete_contact method. boto3 documentation

# delete_contact method definition

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

kwargs: DeleteContactRequestRequestTypeDef = {  # (1)
    "ContactId": ...,
}

parent.delete_contact(**kwargs)
  1. See DeleteContactRequestRequestTypeDef

delete_contact_channel#

To no longer receive engagements on a contact channel, you can delete the channel from a contact.

Type annotations and code completion for boto3.client("ssm-contacts").delete_contact_channel method. boto3 documentation

# delete_contact_channel method definition

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

kwargs: DeleteContactChannelRequestRequestTypeDef = {  # (1)
    "ContactChannelId": ...,
}

parent.delete_contact_channel(**kwargs)
  1. See DeleteContactChannelRequestRequestTypeDef

delete_rotation#

Deletes a rotation from the system.

Type annotations and code completion for boto3.client("ssm-contacts").delete_rotation method. boto3 documentation

# delete_rotation method definition

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

kwargs: DeleteRotationRequestRequestTypeDef = {  # (1)
    "RotationId": ...,
}

parent.delete_rotation(**kwargs)
  1. See DeleteRotationRequestRequestTypeDef

delete_rotation_override#

Deletes an existing override for an on-call rotation.

Type annotations and code completion for boto3.client("ssm-contacts").delete_rotation_override method. boto3 documentation

# delete_rotation_override method definition

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

kwargs: DeleteRotationOverrideRequestRequestTypeDef = {  # (1)
    "RotationId": ...,
    "RotationOverrideId": ...,
}

parent.delete_rotation_override(**kwargs)
  1. See DeleteRotationOverrideRequestRequestTypeDef

describe_engagement#

Incident Manager uses engagements to engage contacts and escalation plans during an incident.

Type annotations and code completion for boto3.client("ssm-contacts").describe_engagement method. boto3 documentation

# describe_engagement method definition

def describe_engagement(
    self,
    *,
    EngagementId: str,
) -> DescribeEngagementResultTypeDef:  # (1)
    ...
  1. See DescribeEngagementResultTypeDef
# describe_engagement method usage example with argument unpacking

kwargs: DescribeEngagementRequestRequestTypeDef = {  # (1)
    "EngagementId": ...,
}

parent.describe_engagement(**kwargs)
  1. See DescribeEngagementRequestRequestTypeDef

describe_page#

Lists details of the engagement to a contact channel.

Type annotations and code completion for boto3.client("ssm-contacts").describe_page method.