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

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.

Usage example

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

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)

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

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

Usage example with kwargs

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

Method definition

def activate_contact_channel(
    self,
    *,
    ContactChannelId: str,
    ActivationCode: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

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

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.create_contact_channel(**kwargs)

1. See CreateContactChannelRequestRequestTypeDef

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

Method definition

def deactivate_contact_channel(
    self,
    *,
    ContactChannelId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_contact(
    self,
    *,
    ContactId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_contact_channel(
    self,
    *,
    ContactChannelId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_contact_channel(**kwargs)

1. See DeleteContactChannelRequestRequestTypeDef

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

Method definition

def describe_engagement(
    self,
    *,
    EngagementId: str,
) -> DescribeEngagementResultTypeDef:  # (1)
    ...

1. See DescribeEngagementResultTypeDef

Usage example with kwargs

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. boto3 documentation

Method definition

def describe_page(
    self,
    *,
    PageId: str,
) -> DescribePageResultTypeDef:  # (1)
    ...

1. See DescribePageResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").generate_presigned_url method. boto3 documentation

Method definition

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 boto3.client("ssm-contacts").get_contact method. boto3 documentation

Method definition

def get_contact(
    self,
    *,
    ContactId: str,
) -> GetContactResultTypeDef:  # (1)
    ...

1. See GetContactResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").get_contact_channel method. boto3 documentation

Method definition

def get_contact_channel(
    self,
    *,
    ContactChannelId: str,
) -> GetContactChannelResultTypeDef:  # (1)
    ...

1. See GetContactChannelResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").get_contact_policy method. boto3 documentation

Method definition

def get_contact_policy(
    self,
    *,
    ContactArn: str,
) -> GetContactPolicyResultTypeDef:  # (1)
    ...

1. See GetContactPolicyResultTypeDef

Usage example with kwargs

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

parent.get_contact_policy(**kwargs)

1. See GetContactPolicyRequestRequestTypeDef

list_contact_channels

Lists all contact channels for the specified contact.

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

Method definition

def list_contact_channels(
    self,
    *,
    ContactId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListContactChannelsResultTypeDef:  # (1)
    ...

1. See ListContactChannelsResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").list_contacts method. boto3 documentation

Method definition

def list_contacts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    AliasPrefix: str = ...,
    Type: ContactTypeType = ...,  # (1)
) -> ListContactsResultTypeDef:  # (2)
    ...

1. See ContactTypeType
2. See ListContactsResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").list_engagements method. boto3 documentation

Method definition

def list_engagements(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    IncidentId: str = ...,
    TimeRangeValue: TimeRangeTypeDef = ...,  # (1)
) -> ListEngagementsResultTypeDef:  # (2)
    ...

1. See TimeRangeTypeDef
2. See ListEngagementsResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").list_page_receipts method. boto3 documentation

Method definition

def list_page_receipts(
    self,
    *,
    PageId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPageReceiptsResultTypeDef:  # (1)
    ...

1. See ListPageReceiptsResultTypeDef

Usage example with kwargs

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

parent.list_page_receipts(**kwargs)

1. See ListPageReceiptsRequestRequestTypeDef

list_pages_by_contact

Lists the engagements to a contact's contact channels.

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

Method definition

def list_pages_by_contact(
    self,
    *,
    ContactId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPagesByContactResultTypeDef:  # (1)
    ...

1. See ListPagesByContactResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").list_pages_by_engagement method. boto3 documentation

Method definition

def list_pages_by_engagement(
    self,
    *,
    EngagementId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPagesByEngagementResultTypeDef:  # (1)
    ...

1. See ListPagesByEngagementResultTypeDef

Usage example with kwargs

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

parent.list_pages_by_engagement(**kwargs)

1. See ListPagesByEngagementRequestRequestTypeDef

list_tags_for_resource

Lists the tags of an escalation plan or contact.

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...

1. See ListTagsForResourceResultTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").put_contact_policy method. boto3 documentation

Method definition

def put_contact_policy(
    self,
    *,
    ContactArn: str,
    Policy: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 boto3.client("ssm-contacts").send_activation_code method. boto3 documentation

Method definition

def send_activation_code(
    self,
    *,
    ContactChannelId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 boto3.client("ssm-contacts").start_engagement method. boto3 documentation

Method definition

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

Usage example with kwargs

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 boto3.client("ssm-contacts").stop_engagement method. boto3 documentation

Method definition

def stop_engagement(
    self,
    *,
    EngagementId: str,
    Reason: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 boto3.client("ssm-contacts").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 boto3.client("ssm-contacts").update_contact method. boto3 documentation

Method definition

def update_contact(
    self,
    *,
    ContactId: str,
    DisplayName: str = ...,
    Plan: PlanTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See PlanTypeDef

Usage example with kwargs

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 boto3.client("ssm-contacts").update_contact_channel method. boto3 documentation

Method definition

def update_contact_channel(
    self,
    *,
    ContactChannelId: str,
    Name: str = ...,
    DeliveryAddress: ContactChannelAddressTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See ContactChannelAddressTypeDef

Usage example with kwargs

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

parent.update_contact_channel(**kwargs)

1. See UpdateContactChannelRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_contact_channels") -> ListContactChannelsPaginator
• client.get_paginator("list_contacts") -> ListContactsPaginator
• client.get_paginator("list_engagements") -> ListEngagementsPaginator
• client.get_paginator("list_page_receipts") -> ListPageReceiptsPaginator
• client.get_paginator("list_pages_by_contact") -> ListPagesByContactPaginator
• client.get_paginator("list_pages_by_engagement") -> ListPagesByEngagementPaginator