Skip to content

SSMContactsClient#

Index > SSMContacts > SSMContactsClient

Auto-generated documentation for SSMContacts type annotations stubs module types-aiobotocore-ssm-contacts.

SSMContactsClient#

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

SSMContactsClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_ssm_contacts.client import SSMContactsClient

session = get_session()
async with session.create_client("ssm-contacts") as client:
    client: SSMContactsClient

Exceptions#

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

SSMContactsClient.exceptions usage example

async with session.create_client("ssm-contacts") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.DataEncryptionException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)
SSMContactsClient usage type checking example

from types_aiobotocore_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 session.create_client("ssm-contacts").accept_page method. boto3 documentation

# accept_page method definition

await 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 session.create_client("ssm-contacts").activate_contact_channel method. boto3 documentation

# activate_contact_channel method definition

await 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 session.create_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 session.create_client("ssm-contacts").close method. boto3 documentation

# close method definition

await 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 session.create_client("ssm-contacts").create_contact method. boto3 documentation

# create_contact method definition

await 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 session.create_client("ssm-contacts").create_contact_channel method. boto3 documentation

# create_contact_channel method definition

await 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 session.create_client("ssm-contacts").create_rotation method. boto3 documentation

# create_rotation method definition

await 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 session.create_client("ssm-contacts").create_rotation_override method. boto3 documentation

# create_rotation_override method definition

await 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 session.create_client("ssm-contacts").deactivate_contact_channel method. boto3 documentation

# deactivate_contact_channel method definition

await 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 session.create_client("ssm-contacts").delete_contact method. boto3 documentation

# delete_contact method definition

await 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 session.create_client("ssm-contacts").delete_contact_channel method. boto3 documentation

# delete_contact_channel method definition

await 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 session.create_client("ssm-contacts").delete_rotation method. boto3 documentation

# delete_rotation method definition

await 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 session.create_client("ssm-contacts").delete_rotation_override method. boto3 documentation

# delete_rotation_override method definition

await 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 session.create_client("ssm-contacts").describe_engagement method. boto3 documentation

# describe_engagement method definition

await 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 session.create_client("ssm-contacts").describe_page method. boto3 documentation

# describe_page method definition

await def describe_page(
    self,
    *,
    PageId: str,
) -> DescribePageResultTypeDef:  # (1)
    ...
  1. See DescribePageResultTypeDef
# describe_page method usage example with argument unpacking

kwargs: DescribePageRequestRequestTypeDef = {  # (1)
    "PageId": ...,
}

parent.describe_page(**kwargs)
  1. See DescribePageRequestRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for session.create_client("ssm-contacts").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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

get_contact#

Retrieves information about the specified contact or escalation plan.

Type annotations and code completion for session.create_client("ssm-contacts").get_contact method. boto3 documentation

# get_contact method definition

await def get_contact(
    self,
    *,
    ContactId: str,
) -> GetContactResultTypeDef:  # (1)
    ...
  1. See GetContactResultTypeDef
# get_contact method usage example with argument unpacking

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

parent.get_contact(**kwargs)
  1. See GetContactRequestRequestTypeDef

get_contact_channel#

List details about a specific contact channel.

Type annotations and code completion for session.create_client("ssm-contacts").get_contact_channel method. boto3 documentation

# get_contact_channel method definition

await def get_contact_channel(
    self,
    *,
    ContactChannelId: str,
) -> GetContactChannelResultTypeDef:  # (1)
    ...
  1. See GetContactChannelResultTypeDef
# get_contact_channel method usage example with argument unpacking

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

parent.get_contact_channel(**kwargs)
  1. See GetContactChannelRequestRequestTypeDef

get_contact_policy#

Retrieves the resource policies attached to the specified contact or escalation plan.

Type annotations and code completion for session.create_client("ssm-contacts").get_contact_policy method. boto3 documentation

# get_contact_policy method definition

await def get_contact_policy(
    self,
    *,
    ContactArn: str,
) -> GetContactPolicyResultTypeDef:  # (1)
    ...
  1. See GetContactPolicyResultTypeDef
# get_contact_policy method usage example with argument unpacking

kwargs: GetContactPolicyRequestRequestTypeDef = {  # (1)
    "ContactArn": ...,
}

parent.get_contact_policy(**kwargs)
  1. See GetContactPolicyRequestRequestTypeDef

get_rotation#

Retrieves information about an on-call rotation.

Type annotations and code completion for session.create_client("ssm-contacts").get_rotation method. boto3 documentation

# get_rotation method definition

await def get_rotation(
    self,
    *,
    RotationId: str,
) -> GetRotationResultTypeDef:  # (1)
    ...
  1. See GetRotationResultTypeDef
# get_rotation method usage example with argument unpacking

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

parent.get_rotation(**kwargs)
  1. See GetRotationRequestRequestTypeDef

get_rotation_override#

Retrieves information about an override to an on-call rotation.

Type annotations and code completion for session.create_client("ssm-contacts").get_rotation_override method. boto3 documentation

# get_rotation_override method definition

await def get_rotation_override(
    self,
    *,
    RotationId: str,
    RotationOverrideId: str,
) -> GetRotationOverrideResultTypeDef:  # (1)
    ...
  1. See GetRotationOverrideResultTypeDef
# get_rotation_override method usage example with argument unpacking

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

parent.get_rotation_override(**kwargs)
  1. See GetRotationOverrideRequestRequestTypeDef

list_contact_channels#

Lists all contact channels for the specified contact.

Type annotations and code completion for session.create_client("ssm-contacts").list_contact_channels method. boto3 documentation

# list_contact_channels method definition

await def list_contact_channels(
    self,
    *,
    ContactId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListContactChannelsResultTypeDef:  # (1)
    ...
  1. See ListContactChannelsResultTypeDef
# list_contact_channels method usage example with argument unpacking

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

parent.list_contact_channels(**kwargs)
  1. See ListContactChannelsRequestRequestTypeDef

list_contacts#

Lists all contacts and escalation plans in Incident Manager.

Type annotations and code completion for session.create_client("ssm-contacts").list_contacts method. boto3 documentation

# list_contacts method definition

await def list_contacts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    AliasPrefix: str = ...,
    Type: ContactTypeType = ...,  # (1)
) -> ListContactsResultTypeDef:  # (2)
    ...
  1. See ContactTypeType
  2. See ListContactsResultTypeDef
# list_contacts method usage example with argument unpacking

kwargs: ListContactsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_contacts(**kwargs)
  1. See ListContactsRequestRequestTypeDef

list_engagements#

Lists all engagements that have happened in an incident.

Type annotations and code completion for session.create_client("ssm-contacts").list_engagements method. boto3 documentation

# list_engagements method definition

await def list_engagements(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    IncidentId: str = ...,
    TimeRangeValue: TimeRangeTypeDef = ...,  # (1)
) -> ListEngagementsResultTypeDef:  # (2)
    ...
  1. See TimeRangeTypeDef
  2. See ListEngagementsResultTypeDef
# list_engagements method usage example with argument unpacking

kwargs: ListEngagementsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_engagements(**kwargs)
  1. See ListEngagementsRequestRequestTypeDef

list_page_receipts#

Lists all of the engagements to contact channels that have been acknowledged.

Type annotations and code completion for session.create_client("ssm-contacts").list_page_receipts method. boto3 documentation

# list_page_receipts method definition

await def list_page_receipts(
    self,
    *,
    PageId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPageReceiptsResultTypeDef:  # (1)
    ...
  1. See ListPageReceiptsResultTypeDef
# list_page_receipts method usage example with argument unpacking

kwargs: ListPageReceiptsRequestRequestTypeDef = {  # (1)
    "PageId": ...,
}

parent.list_page_receipts(**kwargs)
  1. See ListPageReceiptsRequestRequestTypeDef

list_page_resolutions#

Returns the resolution path of an engagement.

Type annotations and code completion for session.create_client("ssm-contacts").list_page_resolutions method. boto3 documentation

# list_page_resolutions method definition

await def list_page_resolutions(
    self,
    *,
    PageId: str,
    NextToken: str = ...,
) -> ListPageResolutionsResultTypeDef:  # (1)
    ...
  1. See ListPageResolutionsResultTypeDef
# list_page_resolutions method usage example with argument unpacking

kwargs: ListPageResolutionsRequestRequestTypeDef = {  # (1)
    "PageId": ...,
}

parent.list_page_resolutions(**kwargs)
  1. See ListPageResolutionsRequestRequestTypeDef

list_pages_by_contact#

Lists the engagements to a contact's contact channels.

Type annotations and code completion for session.create_client("ssm-contacts").list_pages_by_contact method. boto3 documentation

# list_pages_by_contact method definition

await def list_pages_by_contact(
    self,
    *,
    ContactId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPagesByContactResultTypeDef:  # (1)
    ...
  1. See ListPagesByContactResultTypeDef
# list_pages_by_contact method usage example with argument unpacking

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

parent.list_pages_by_contact(**kwargs)
  1. See ListPagesByContactRequestRequestTypeDef

list_pages_by_engagement#

Lists the engagements to contact channels that occurred by engaging a contact.

Type annotations and code completion for session.create_client("ssm-contacts").list_pages_by_engagement method. boto3 documentation

# list_pages_by_engagement method definition

await def list_pages_by_engagement(
    self,
    *,
    EngagementId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPagesByEngagementResultTypeDef:  # (1)
    ...
  1. See ListPagesByEngagementResultTypeDef
# list_pages_by_engagement method usage example with argument unpacking

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

parent.list_pages_by_engagement(**kwargs)
  1. See ListPagesByEngagementRequestRequestTypeDef

list_preview_rotation_shifts#

Returns a list of shifts based on rotation configuration parameters.

Type annotations and code completion for session.create_client("ssm-contacts").list_preview_rotation_shifts method. boto3 documentation

# list_preview_rotation_shifts method definition

await def list_preview_rotation_shifts(
    self,
    *,
    EndTime: Union[datetime, str],
    Members: Sequence[str],
    TimeZoneId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    RotationStartTime: Union[datetime, str] = ...,
    StartTime: Union[datetime, str] = ...,
    Overrides: Sequence[PreviewOverrideTypeDef] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPreviewRotationShiftsResultTypeDef:  # (3)
    ...
  1. See RecurrenceSettingsTypeDef
  2. See PreviewOverrideTypeDef
  3. See ListPreviewRotationShiftsResultTypeDef
# list_preview_rotation_shifts method usage example with argument unpacking

kwargs: ListPreviewRotationShiftsRequestRequestTypeDef = {  # (1)
    "EndTime": ...,
    "Members": ...,
    "TimeZoneId": ...,
    "Recurrence": ...,
}

parent.list_preview_rotation_shifts(**kwargs)
  1. See ListPreviewRotationShiftsRequestRequestTypeDef

list_rotation_overrides#

Retrieves a list of overrides currently specified for an on-call rotation.

Type annotations and code completion for session.create_client("ssm-contacts").list_rotation_overrides method. boto3 documentation

# list_rotation_overrides method definition

await def list_rotation_overrides(
    self,
    *,
    RotationId: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRotationOverridesResultTypeDef:  # (1)
    ...
  1. See ListRotationOverridesResultTypeDef
# list_rotation_overrides method usage example with argument unpacking

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

parent.list_rotation_overrides(**kwargs)
  1. See ListRotationOverridesRequestRequestTypeDef

list_rotation_shifts#

Returns a list of shifts generated by an existing rotation in the system.

Type annotations and code completion for session.create_client("ssm-contacts").list_rotation_shifts method. boto3 documentation

# list_rotation_shifts method definition

await def list_rotation_shifts(
    self,
    *,
    RotationId: str,
    EndTime: Union[datetime, str],
    StartTime: Union[datetime, str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRotationShiftsResultTypeDef:  # (1)
    ...
  1. See ListRotationShiftsResultTypeDef
# list_rotation_shifts method usage example with argument unpacking

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

parent.list_rotation_shifts(**kwargs)
  1. See ListRotationShiftsRequestRequestTypeDef

list_rotations#

Retrieves a list of on-call rotations.

Type annotations and code completion for session.create_client("ssm-contacts").list_rotations method. boto3 documentation

# list_rotations method definition

await def list_rotations(
    self,
    *,
    RotationNamePrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRotationsResultTypeDef:  # (1)
    ...
  1. See ListRotationsResultTypeDef
# list_rotations method usage example with argument unpacking

kwargs: ListRotationsRequestRequestTypeDef = {  # (1)
    "RotationNamePrefix": ...,
}

parent.list_rotations(**kwargs)
  1. See ListRotationsRequestRequestTypeDef

list_tags_for_resource#

Lists the tags of an escalation plan or contact.

Type annotations and code completion for session.create_client("ssm-contacts").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

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

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

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

put_contact_policy#

Adds a resource policy to the specified contact or escalation plan.

Type annotations and code completion for session.create_client("ssm-contacts").put_contact_policy method. boto3 documentation

# put_contact_policy method definition

await def put_contact_policy(
    self,
    *,
    ContactArn: str,
    Policy: str,
) -> Dict[str, Any]:
    ...
# put_contact_policy method usage example with argument unpacking

kwargs: PutContactPolicyRequestRequestTypeDef = {  # (1)
    "ContactArn": ...,
    "Policy": ...,
}

parent.put_contact_policy(**kwargs)
  1. See PutContactPolicyRequestRequestTypeDef

send_activation_code#

Sends an activation code to a contact channel.

Type annotations and code completion for session.create_client("ssm-contacts").send_activation_code method. boto3 documentation

# send_activation_code method definition

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

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

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

start_engagement#

Starts an engagement to a contact or escalation plan.

Type annotations and code completion for session.create_client("ssm-contacts").start_engagement method. boto3 documentation

# start_engagement method definition

await def start_engagement(
    self,
    *,
    ContactId: str,
    Sender: str,
    Subject: str,
    Content: str,
    PublicSubject: str = ...,
    PublicContent: str = ...,
    IncidentId: str = ...,
    IdempotencyToken: str = ...,
) -> StartEngagementResultTypeDef:  # (1)
    ...
  1. See StartEngagementResultTypeDef
# start_engagement method usage example with argument unpacking

kwargs: StartEngagementRequestRequestTypeDef = {  # (1)
    "ContactId": ...,
    "Sender": ...,
    "Subject": ...,
    "Content": ...,
}

parent.start_engagement(**kwargs)
  1. See StartEngagementRequestRequestTypeDef

stop_engagement#

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.

Type annotations and code completion for session.create_client("ssm-contacts").stop_engagement method. boto3 documentation

# stop_engagement method definition

await def stop_engagement(
    self,
    *,
    EngagementId: str,
    Reason: str = ...,
) -> Dict[str, Any]:
    ...
# stop_engagement method usage example with argument unpacking

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

parent.stop_engagement(**kwargs)
  1. See StopEngagementRequestRequestTypeDef

tag_resource#

Tags a contact or escalation plan.

Type annotations and code completion for session.create_client("ssm-contacts").tag_resource method. boto3 documentation

# tag_resource method definition

await def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

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

untag_resource#

Removes tags from the specified resource.

Type annotations and code completion for session.create_client("ssm-contacts").untag_resource method. boto3 documentation

# untag_resource method definition

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

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

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

update_contact#

Updates the contact or escalation plan specified.

Type annotations and code completion for session.create_client("ssm-contacts").update_contact method. boto3 documentation

# update_contact method definition

await def update_contact(
    self,
    *,
    ContactId: str,
    DisplayName: str = ...,
    Plan: PlanTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See PlanTypeDef
# update_contact method usage example with argument unpacking

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

parent.update_contact(**kwargs)
  1. See UpdateContactRequestRequestTypeDef

update_contact_channel#

Updates a contact's contact channel.

Type annotations and code completion for session.create_client("ssm-contacts").update_contact_channel method. boto3 documentation

# update_contact_channel method definition

await def update_contact_channel(
    self,
    *,
    ContactChannelId: str,
    Name: str = ...,
    DeliveryAddress: ContactChannelAddressTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ContactChannelAddressTypeDef
# update_contact_channel method usage example with argument unpacking

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

parent.update_contact_channel(**kwargs)
  1. See UpdateContactChannelRequestRequestTypeDef

update_rotation#

Updates the information specified for an on-call rotation.

Type annotations and code completion for session.create_client("ssm-contacts").update_rotation method. boto3 documentation

# update_rotation method definition

await def update_rotation(
    self,
    *,
    RotationId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    ContactIds: Sequence[str] = ...,
    StartTime: Union[datetime, str] = ...,
    TimeZoneId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See RecurrenceSettingsTypeDef
# update_rotation method usage example with argument unpacking

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

parent.update_rotation(**kwargs)
  1. See UpdateRotationRequestRequestTypeDef

__aenter__#

Type annotations and code completion for session.create_client("ssm-contacts").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> SSMContactsClient:
    ...

__aexit__#

Type annotations and code completion for session.create_client("ssm-contacts").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator#

Type annotations and code completion for session.create_client("ssm-contacts").get_paginator method with overloads.