AcceptPage

$result = $client->acceptPage([/* ... */]);
$promise = $client->acceptPageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->acceptPage([
    'AcceptCode' => '<string>', // REQUIRED
    'AcceptCodeValidation' => 'IGNORE|ENFORCE',
    'AcceptType' => 'DELIVERED|READ', // REQUIRED
    'ContactChannelId' => '<string>',
    'Note' => '<string>',
    'PageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To accept a page during and engagement

The following accept-page operation uses an accept code sent to the contact channel to accept a page.

$result = $client->acceptPage([
    'AcceptCode' => '425440',
    'AcceptType' => 'READ',
    'PageId' => 'arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3',
]);

Result syntax:

[
]

ActivateContactChannel

$result = $client->activateContactChannel([/* ... */]);
$promise = $client->activateContactChannelAsync([/* ... */]);

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

Parameter Syntax

$result = $client->activateContactChannel([
    'ActivationCode' => '<string>', // REQUIRED
    'ContactChannelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: Activate a contact's contact channel

The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.

$result = $client->activateContactChannel([
    'ActivationCode' => '466136',
    'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
]);

Result syntax:

[
]

CreateContact

$result = $client->createContact([/* ... */]);
$promise = $client->createContactAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createContact([
    'Alias' => '<string>', // REQUIRED
    'DisplayName' => '<string>',
    'IdempotencyToken' => '<string>',
    'Plan' => [ // REQUIRED
        'RotationIds' => ['<string>', ...],
        'Stages' => [
            [
                'DurationInMinutes' => <integer>, // REQUIRED
                'Targets' => [ // REQUIRED
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => '<string>', // REQUIRED
                            'RetryIntervalInMinutes' => <integer>,
                        ],
                        'ContactTargetInfo' => [
                            'ContactId' => '<string>',
                            'IsEssential' => true || false, // REQUIRED
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Type' => 'PERSONAL|ESCALATION|ONCALL_SCHEDULE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

InternalServerException:

Unexpected error occurred while processing the request.

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

DataEncryptionException:

The operation failed to due an encryption key error.

Examples

Example 1: To create a contact

The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan.

$result = $client->createContact([
    'Alias' => 'akuam',
    'DisplayName' => 'Akua Mansa',
    'Plan' => [
        'Stages' => [
        ],
    ],
    'Type' => 'PERSONAL',
]);

Result syntax:

[
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
]

CreateContactChannel

$result = $client->createContactChannel([/* ... */]);
$promise = $client->createContactChannelAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createContactChannel([
    'ContactId' => '<string>', // REQUIRED
    'DeferActivation' => true || false,
    'DeliveryAddress' => [ // REQUIRED
        'SimpleAddress' => '<string>',
    ],
    'IdempotencyToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Type' => 'SMS|VOICE|EMAIL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactChannelArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To create a contact channel

Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.

$result = $client->createContactChannel([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
    'DeliveryAddress' => [
        'SimpleAddress' => '+15005550199',
    ],
    'Name' => 'akuas sms-test',
    'Type' => 'SMS',
]);

Result syntax:

[
    'ContactChannelArn' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024',
]

CreateRotation

$result = $client->createRotation([/* ... */]);
$promise = $client->createRotationAsync([/* ... */]);

Creates a rotation in an on-call schedule.

Parameter Syntax

$result = $client->createRotation([
    'ContactIds' => ['<string>', ...], // REQUIRED
    'IdempotencyToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Recurrence' => [ // REQUIRED
        'DailySettings' => [
            [
                'HourOfDay' => <integer>, // REQUIRED
                'MinuteOfHour' => <integer>, // REQUIRED
            ],
            // ...
        ],
        'MonthlySettings' => [
            [
                'DayOfMonth' => <integer>, // REQUIRED
                'HandOffTime' => [ // REQUIRED
                    'HourOfDay' => <integer>, // REQUIRED
                    'MinuteOfHour' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
        'NumberOfOnCalls' => <integer>, // REQUIRED
        'RecurrenceMultiplier' => <integer>, // REQUIRED
        'ShiftCoverages' => [
            '<DayOfWeek>' => [
                [
                    'End' => [
                        'HourOfDay' => <integer>, // REQUIRED
                        'MinuteOfHour' => <integer>, // REQUIRED
                    ],
                    'Start' => [
                        'HourOfDay' => <integer>, // REQUIRED
                        'MinuteOfHour' => <integer>, // REQUIRED
                    ],
                ],
                // ...
            ],
            // ...
        ],
        'WeeklySettings' => [
            [
                'DayOfWeek' => 'MON|TUE|WED|THU|FRI|SAT|SUN', // REQUIRED
                'HandOffTime' => [ // REQUIRED
                    'HourOfDay' => <integer>, // REQUIRED
                    'MinuteOfHour' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'StartTime' => <integer || string || DateTime>,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TimeZoneId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RotationArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

CreateRotationOverride

$result = $client->createRotationOverride([/* ... */]);
$promise = $client->createRotationOverrideAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createRotationOverride([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'IdempotencyToken' => '<string>',
    'NewContactIds' => ['<string>', ...], // REQUIRED
    'RotationId' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RotationOverrideId' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

DeactivateContactChannel

$result = $client->deactivateContactChannel([/* ... */]);
$promise = $client->deactivateContactChannelAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deactivateContactChannel([
    'ContactChannelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To deactivate a contact channel

The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time using the activate-contact-channel operation.

$result = $client->deactivateContactChannel([
    'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
]);

Result syntax:

[
]

DeleteContact

$result = $client->deleteContact([/* ... */]);
$promise = $client->deleteContactAsync([/* ... */]);

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.

Parameter Syntax

$result = $client->deleteContact([
    'ContactId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To delete a contact

The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.

$result = $client->deleteContact([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr',
]);

Result syntax:

[
]

DeleteContactChannel

$result = $client->deleteContactChannel([/* ... */]);
$promise = $client->deleteContactChannelAsync([/* ... */]);

To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.

Parameter Syntax

$result = $client->deleteContactChannel([
    'ContactChannelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To delete a contact channel

The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact channel will not be paged during an incident.

$result = $client->deleteContactChannel([
    'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2',
]);

Result syntax:

[
]

DeleteRotation

$result = $client->deleteRotation([/* ... */]);
$promise = $client->deleteRotationAsync([/* ... */]);

Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.

Parameter Syntax

$result = $client->deleteRotation([
    'RotationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

DeleteRotationOverride

$result = $client->deleteRotationOverride([/* ... */]);
$promise = $client->deleteRotationOverrideAsync([/* ... */]);

Deletes an existing override for an on-call rotation.

Parameter Syntax

$result = $client->deleteRotationOverride([
    'RotationId' => '<string>', // REQUIRED
    'RotationOverrideId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

DescribeEngagement

$result = $client->describeEngagement([/* ... */]);
$promise = $client->describeEngagementAsync([/* ... */]);

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Parameter Syntax

$result = $client->describeEngagement([
    'EngagementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactArn' => '<string>',
    'Content' => '<string>',
    'EngagementArn' => '<string>',
    'IncidentId' => '<string>',
    'PublicContent' => '<string>',
    'PublicSubject' => '<string>',
    'Sender' => '<string>',
    'StartTime' => <DateTime>,
    'StopTime' => <DateTime>,
    'Subject' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To describe the details of an engagement

The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels.

$result = $client->describeEngagement([
    'EngagementId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
]);

Result syntax:

[
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
    'Content' => 'Testing engagements',
    'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
    'PublicContent' => 'Testing engagements',
    'PublicSubject' => 'test',
    'Sender' => 'tester',
    'StartTime' => ,
    'Subject' => 'test',
]

DescribePage

$result = $client->describePage([/* ... */]);
$promise = $client->describePageAsync([/* ... */]);

Lists details of the engagement to a contact channel.

Parameter Syntax

$result = $client->describePage([
    'PageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactArn' => '<string>',
    'Content' => '<string>',
    'DeliveryTime' => <DateTime>,
    'EngagementArn' => '<string>',
    'IncidentId' => '<string>',
    'PageArn' => '<string>',
    'PublicContent' => '<string>',
    'PublicSubject' => '<string>',
    'ReadTime' => <DateTime>,
    'Sender' => '<string>',
    'SentTime' => <DateTime>,
    'Subject' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the details of a page to a contact channel

The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.

$result = $client->describePage([
    'PageId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
]);

Result syntax:

[
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
    'Content' => 'Testing engagements',
    'DeliveryTime' => ,
    'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
    'PageArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
    'PublicContent' => 'Testing engagements',
    'PublicSubject' => 'test',
    'ReadTime' => ,
    'Sender' => 'tester',
    'SentTime' => ,
    'Subject' => 'test',
]

GetContact

$result = $client->getContact([/* ... */]);
$promise = $client->getContactAsync([/* ... */]);

Retrieves information about the specified contact or escalation plan.

Parameter Syntax

$result = $client->getContact([
    'ContactId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Alias' => '<string>',
    'ContactArn' => '<string>',
    'DisplayName' => '<string>',
    'Plan' => [
        'RotationIds' => ['<string>', ...],
        'Stages' => [
            [
                'DurationInMinutes' => <integer>,
                'Targets' => [
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => '<string>',
                            'RetryIntervalInMinutes' => <integer>,
                        ],
                        'ContactTargetInfo' => [
                            'ContactId' => '<string>',
                            'IsEssential' => true || false,
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'Type' => 'PERSONAL|ESCALATION|ONCALL_SCHEDULE',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

DataEncryptionException:

The operation failed to due an encryption key error.

Examples

Example 1: Example 1: To describe a contact plan

The following get-contact example describes a contact.

$result = $client->getContact([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
]);

Result syntax:

[
    'Alias' => 'akuam',
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
    'DisplayName' => 'Akua Mansa',
    'Plan' => [
        'Stages' => [
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65',
                            'RetryIntervalInMinutes' => 1,
                        ],
                    ],
                ],
            ],
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad',
                            'RetryIntervalInMinutes' => 1,
                        ],
                    ],
                ],
            ],
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a',
                            'RetryIntervalInMinutes' => 1,
                        ],
                    ],
                ],
            ],
        ],
    ],
    'Type' => 'PERSONAL',
]

Example 2: Example 2: To describe an escalation plan

The following get-contact example describes an escalation plan.

$result = $client->getContact([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
]);

Result syntax:

[
    'Alias' => 'example_escalation',
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
    'DisplayName' => 'Example Escalation Plan',
    'Plan' => [
        'Stages' => [
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ContactTargetInfo' => [
                            'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
                            'IsEssential' => 1,
                        ],
                    ],
                ],
            ],
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ContactTargetInfo' => [
                            'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr',
                            'IsEssential' => ,
                        ],
                    ],
                ],
            ],
            [
                'DurationInMinutes' => 0,
                'Targets' => [
                    [
                        'ContactTargetInfo' => [
                            'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi',
                            'IsEssential' => ,
                        ],
                    ],
                ],
            ],
        ],
    ],
    'Type' => 'ESCALATION',
]

GetContactChannel

$result = $client->getContactChannel([/* ... */]);
$promise = $client->getContactChannelAsync([/* ... */]);

List details about a specific contact channel.

Parameter Syntax

$result = $client->getContactChannel([
    'ContactChannelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ActivationStatus' => 'ACTIVATED|NOT_ACTIVATED',
    'ContactArn' => '<string>',
    'ContactChannelArn' => '<string>',
    'DeliveryAddress' => [
        'SimpleAddress' => '<string>',
    ],
    'Name' => '<string>',
    'Type' => 'SMS|VOICE|EMAIL',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the details of a contact channel

The following get-contact-channel example lists the details of a contact channel.

$result = $client->getContactChannel([
    'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
]);

Result syntax:

[
    'ActivationStatus' => 'ACTIVATED',
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
    'ContactChannelArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
    'DeliveryAddress' => [
        'SimpleAddress' => '+15005550199',
    ],
    'Name' => 'akuas sms',
    'Type' => 'SMS',
]

GetContactPolicy

$result = $client->getContactPolicy([/* ... */]);
$promise = $client->getContactPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getContactPolicy([
    'ContactArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactArn' => '<string>',
    'Policy' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the resource policies of a contact

The following get-contact-policy example lists the resource policies associated with the specified contact.

$result = $client->getContactPolicy([
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
]);

Result syntax:

[
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
    'Policy' => '{"Version":"2012-10-17","Statement":[{"Sid":"SharePolicyForDocumentationDralia","Effect":"Allow","Principal":{"AWS":"222233334444"},"Action":["ssm-contacts:GetContact","ssm-contacts:StartEngagement","ssm-contacts:DescribeEngagement","ssm-contacts:ListPagesByEngagement","ssm-contacts:StopEngagement"],"Resource":["arn:aws:ssm-contacts:*:111122223333:contact/akuam","arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*"]}]}',
]

GetRotation

$result = $client->getRotation([/* ... */]);
$promise = $client->getRotationAsync([/* ... */]);

Retrieves information about an on-call rotation.

Parameter Syntax

$result = $client->getRotation([
    'RotationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactIds' => ['<string>', ...],
    'Name' => '<string>',
    'Recurrence' => [
        'DailySettings' => [
            [
                'HourOfDay' => <integer>,
                'MinuteOfHour' => <integer>,
            ],
            // ...
        ],
        'MonthlySettings' => [
            [
                'DayOfMonth' => <integer>,
                'HandOffTime' => [
                    'HourOfDay' => <integer>,
                    'MinuteOfHour' => <integer>,
                ],
            ],
            // ...
        ],
        'NumberOfOnCalls' => <integer>,
        'RecurrenceMultiplier' => <integer>,
        'ShiftCoverages' => [
            '<DayOfWeek>' => [
                [
                    'End' => [
                        'HourOfDay' => <integer>,
                        'MinuteOfHour' => <integer>,
                    ],
                    'Start' => [
                        'HourOfDay' => <integer>,
                        'MinuteOfHour' => <integer>,
                    ],
                ],
                // ...
            ],
            // ...
        ],
        'WeeklySettings' => [
            [
                'DayOfWeek' => 'MON|TUE|WED|THU|FRI|SAT|SUN',
                'HandOffTime' => [
                    'HourOfDay' => <integer>,
                    'MinuteOfHour' => <integer>,
                ],
            ],
            // ...
        ],
    ],
    'RotationArn' => '<string>',
    'StartTime' => <DateTime>,
    'TimeZoneId' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

GetRotationOverride

$result = $client->getRotationOverride([/* ... */]);
$promise = $client->getRotationOverrideAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getRotationOverride([
    'RotationId' => '<string>', // REQUIRED
    'RotationOverrideId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreateTime' => <DateTime>,
    'EndTime' => <DateTime>,
    'NewContactIds' => ['<string>', ...],
    'RotationArn' => '<string>',
    'RotationOverrideId' => '<string>',
    'StartTime' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListContactChannels

$result = $client->listContactChannels([/* ... */]);
$promise = $client->listContactChannelsAsync([/* ... */]);

Lists all contact channels for the specified contact.

Parameter Syntax

$result = $client->listContactChannels([
    'ContactId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContactChannels' => [
        [
            'ActivationStatus' => 'ACTIVATED|NOT_ACTIVATED',
            'ContactArn' => '<string>',
            'ContactChannelArn' => '<string>',
            'DeliveryAddress' => [
                'SimpleAddress' => '<string>',
            ],
            'Name' => '<string>',
            'Type' => 'SMS|VOICE|EMAIL',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list the contact channels of a contact

The following list-contact-channels example lists the available contact channels of the specified contact.

$result = $client->listContactChannels([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
]);

Result syntax:

[
    'ContactChannels' => [
        [
            'ActivationStatus' => 'ACTIVATED',
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'ContactChannelArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
            'DeliveryAddress' => [
                'SimpleAddress' => '+15005550100',
            ],
            'Name' => 'akuas sms',
            'Type' => 'SMS',
        ],
    ],
]

ListContacts

$result = $client->listContacts([/* ... */]);
$promise = $client->listContactsAsync([/* ... */]);

Lists all contacts and escalation plans in Incident Manager.

Parameter Syntax

$result = $client->listContacts([
    'AliasPrefix' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Type' => 'PERSONAL|ESCALATION|ONCALL_SCHEDULE',
]);

Parameter Details

Result Syntax

[
    'Contacts' => [
        [
            'Alias' => '<string>',
            'ContactArn' => '<string>',
            'DisplayName' => '<string>',
            'Type' => 'PERSONAL|ESCALATION|ONCALL_SCHEDULE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list all escalation plans and contacts

The following list-contacts example lists the contacts and escalation plans in your account.

$result = $client->listContacts([
]);

Result syntax:

[
    'Contacts' => [
        [
            'Alias' => 'akuam',
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'DisplayName' => 'Akua Mansa',
            'Type' => 'PERSONAL',
        ],
        [
            'Alias' => 'alejr',
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr',
            'DisplayName' => 'Alejandro Rosalez',
            'Type' => 'PERSONAL',
        ],
        [
            'Alias' => 'anasi',
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi',
            'DisplayName' => 'Ana Carolina Silva',
            'Type' => 'PERSONAL',
        ],
        [
            'Alias' => 'example_escalation',
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
            'DisplayName' => 'Example Escalation',
            'Type' => 'ESCALATION',
        ],
    ],
]

ListEngagements

$result = $client->listEngagements([/* ... */]);
$promise = $client->listEngagementsAsync([/* ... */]);

Lists all engagements that have happened in an incident.

Parameter Syntax

$result = $client->listEngagements([
    'IncidentId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TimeRangeValue' => [
        'EndTime' => <integer || string || DateTime>,
        'StartTime' => <integer || string || DateTime>,
    ],
]);

Parameter Details

Result Syntax

[
    'Engagements' => [
        [
            'ContactArn' => '<string>',
            'EngagementArn' => '<string>',
            'IncidentId' => '<string>',
            'Sender' => '<string>',
            'StartTime' => <DateTime>,
            'StopTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list all engagements

The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements for a single incident.

$result = $client->listEngagements([
]);

Result syntax:

[
    'Engagements' => [
        [
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529',
            'Sender' => 'cli',
            'StartTime' => ,
        ],
        [
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
            'Sender' => 'cli',
            'StartTime' => ,
        ],
        [
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
            'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
            'Sender' => 'cli',
            'StartTime' => ,
        ],
        [
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f',
            'Sender' => 'cli',
            'StartTime' => ,
        ],
    ],
]

ListPageReceipts

$result = $client->listPageReceipts([/* ... */]);
$promise = $client->listPageReceiptsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPageReceipts([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Receipts' => [
        [
            'ContactChannelArn' => '<string>',
            'ReceiptInfo' => '<string>',
            'ReceiptTime' => <DateTime>,
            'ReceiptType' => 'DELIVERED|ERROR|READ|SENT|STOP',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list page receipts

The following command-name example lists whether a page was received or not by a contact.

$result = $client->listPageReceipts([
    'PageId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3',
]);

Result syntax:

[
    'Receipts' => [
        [
            'ContactChannelArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
            'ReceiptInfo' => '425440',
            'ReceiptTime' => ,
            'ReceiptType' => 'DELIVERED',
        ],
        [
            'ContactChannelArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
            'ReceiptInfo' => '425440',
            'ReceiptTime' => ,
            'ReceiptType' => 'READ',
        ],
        [
            'ContactChannelArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
            'ReceiptInfo' => 'SM6656c19132f1465f9c9c1123a5dde7c9',
            'ReceiptTime' => ,
            'ReceiptType' => 'SENT',
        ],
    ],
]

ListPageResolutions

$result = $client->listPageResolutions([/* ... */]);
$promise = $client->listPageResolutionsAsync([/* ... */]);

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.

Parameter Syntax

$result = $client->listPageResolutions([
    'NextToken' => '<string>',
    'PageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PageResolutions' => [
        [
            'ContactArn' => '<string>',
            'StageIndex' => <integer>,
            'Type' => 'PERSONAL|ESCALATION|ONCALL_SCHEDULE',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListPagesByContact

$result = $client->listPagesByContact([/* ... */]);
$promise = $client->listPagesByContactAsync([/* ... */]);

Lists the engagements to a contact's contact channels.

Parameter Syntax

$result = $client->listPagesByContact([
    'ContactId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Pages' => [
        [
            'ContactArn' => '<string>',
            'DeliveryTime' => <DateTime>,
            'EngagementArn' => '<string>',
            'IncidentId' => '<string>',
            'PageArn' => '<string>',
            'ReadTime' => <DateTime>,
            'Sender' => '<string>',
            'SentTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list pages by contact

The following list-pages-by-contact example lists all pages to the specified contact.

$result = $client->listPagesByContact([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
]);

Result syntax:

[
    'Pages' => [
        [
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'DeliveryTime' => ,
            'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
            'PageArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
            'ReadTime' => ,
            'Sender' => 'cli',
            'SentTime' => ,
        ],
    ],
]

ListPagesByEngagement

$result = $client->listPagesByEngagement([/* ... */]);
$promise = $client->listPagesByEngagementAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPagesByEngagement([
    'EngagementId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Pages' => [
        [
            'ContactArn' => '<string>',
            'DeliveryTime' => <DateTime>,
            'EngagementArn' => '<string>',
            'IncidentId' => '<string>',
            'PageArn' => '<string>',
            'ReadTime' => <DateTime>,
            'Sender' => '<string>',
            'SentTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To list pages to contact channels started from an engagement.

The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.

$result = $client->listPagesByEngagement([
    'EngagementId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
]);

Result syntax:

[
    'Pages' => [
        [
            'ContactArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
            'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
            'PageArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
            'Sender' => 'cli',
            'SentTime' => ,
        ],
    ],
]

ListPreviewRotationShifts

$result = $client->listPreviewRotationShifts([/* ... */]);
$promise = $client->listPreviewRotationShiftsAsync([/* ... */]);

Returns a list of shifts based on rotation configuration parameters.

Parameter Syntax

$result = $client->listPreviewRotationShifts([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'MaxResults' => <integer>,
    'Members' => ['<string>', ...], // REQUIRED
    'NextToken' => '<string>',
    'Overrides' => [
        [
            'EndTime' => <integer || string || DateTime>,
            'NewMembers' => ['<string>', ...],
            'StartTime' => <integer || string || DateTime>,
        ],
        // ...
    ],
    'Recurrence' => [ // REQUIRED
        'DailySettings' => [
            [
                'HourOfDay' => <integer>, // REQUIRED
                'MinuteOfHour' => <integer>, // REQUIRED
            ],
            // ...
        ],
        'MonthlySettings' => [
            [
                'DayOfMonth' => <integer>, // REQUIRED
                'HandOffTime' => [ // REQUIRED
                    'HourOfDay' => <integer>, // REQUIRED
                    'MinuteOfHour' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
        'NumberOfOnCalls' => <integer>, // REQUIRED
        'RecurrenceMultiplier' => <integer>, // REQUIRED
        'ShiftCoverages' => [
            '<DayOfWeek>' => [
                [
                    'End' => [
                        'HourOfDay' => <integer>, // REQUIRED
                        'MinuteOfHour' => <integer>, // REQUIRED
                    ],
                    'Start' => [
                        'HourOfDay' => <integer>, // REQUIRED
                        'MinuteOfHour' => <integer>, // REQUIRED
                    ],
                ],
                // ...
            ],
            // ...
        ],
        'WeeklySettings' => [
            [
                'DayOfWeek' => 'MON|TUE|WED|THU|FRI|SAT|SUN', // REQUIRED
                'HandOffTime' => [ // REQUIRED
                    'HourOfDay' => <integer>, // REQUIRED
                    'MinuteOfHour' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'RotationStartTime' => <integer || string || DateTime>,
    'StartTime' => <integer || string || DateTime>,
    'TimeZoneId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RotationShifts' => [
        [
            'ContactIds' => ['<string>', ...],
            'EndTime' => <DateTime>,
            'ShiftDetails' => [
                'OverriddenContactIds' => ['<string>', ...],
            ],
            'StartTime' => <DateTime>,
            'Type' => 'REGULAR|OVERRIDDEN',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListRotationOverrides

$result = $client->listRotationOverrides([/* ... */]);
$promise = $client->listRotationOverridesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRotationOverrides([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RotationId' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RotationOverrides' => [
        [
            'CreateTime' => <DateTime>,
            'EndTime' => <DateTime>,
            'NewContactIds' => ['<string>', ...],
            'RotationOverrideId' => '<string>',
            'StartTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListRotationShifts

$result = $client->listRotationShifts([/* ... */]);
$promise = $client->listRotationShiftsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRotationShifts([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RotationId' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RotationShifts' => [
        [
            'ContactIds' => ['<string>', ...],
            'EndTime' => <DateTime>,
            'ShiftDetails' => [
                'OverriddenContactIds' => ['<string>', ...],
            ],
            'StartTime' => <DateTime>,
            'Type' => 'REGULAR|OVERRIDDEN',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListRotations

$result = $client->listRotations([/* ... */]);
$promise = $client->listRotationsAsync([/* ... */]);

Retrieves a list of on-call rotations.

Parameter Syntax

$result = $client->listRotations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RotationNamePrefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Rotations' => [
        [
            'ContactIds' => ['<string>', ...],
            'Name' => '<string>',
            'Recurrence' => [
                'DailySettings' => [
                    [
                        'HourOfDay' => <integer>,
                        'MinuteOfHour' => <integer>,
                    ],
                    // ...
                ],
                'MonthlySettings' => [
                    [
                        'DayOfMonth' => <integer>,
                        'HandOffTime' => [
                            'HourOfDay' => <integer>,
                            'MinuteOfHour' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'NumberOfOnCalls' => <integer>,
                'RecurrenceMultiplier' => <integer>,
                'ShiftCoverages' => [
                    '<DayOfWeek>' => [
                        [
                            'End' => [
                                'HourOfDay' => <integer>,
                                'MinuteOfHour' => <integer>,
                            ],
                            'Start' => [
                                'HourOfDay' => <integer>,
                                'MinuteOfHour' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    // ...
                ],
                'WeeklySettings' => [
                    [
                        'DayOfWeek' => 'MON|TUE|WED|THU|FRI|SAT|SUN',
                        'HandOffTime' => [
                            'HourOfDay' => <integer>,
                            'MinuteOfHour' => <integer>,
                        ],
                    ],
                    // ...
                ],
            ],
            'RotationArn' => '<string>',
            'StartTime' => <DateTime>,
            'TimeZoneId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags of an escalation plan or contact.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

Unexpected error occurred while processing the request.

Examples

Example 1: To list tags for a contact

The following list-tags-for-resource example lists the tags of the specified contact.

$result = $client->listTagsForResource([
    'ResourceARN' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
]);

Result syntax:

[
    'Tags' => [
        [
            'Key' => 'group1',
            'Value' => '1',
        ],
    ],
]

PutContactPolicy

$result = $client->putContactPolicy([/* ... */]);
$promise = $client->putContactPolicyAsync([/* ... */]);

Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.

Parameter Syntax

$result = $client->putContactPolicy([
    'ContactArn' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

Unexpected error occurred while processing the request.

Examples

Example 1: To share a contact and engagements

The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related engagements with the principal.

$result = $client->putContactPolicy([
    'ContactArn' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
    'Policy' => '{"Version":"2012-10-17","Statement":[{"Sid":"ExampleResourcePolicy","Action":["ssm-contacts:GetContact","ssm-contacts:StartEngagement","ssm-contacts:DescribeEngagement","ssm-contacts:ListPagesByEngagement","ssm-contacts:StopEngagement"],"Principal":{"AWS":"222233334444"},"Effect":"Allow","Resource":["arn:aws:ssm-contacts:*:111122223333:contact/akuam","arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*"]}]}',
]);

Result syntax:

[
]

SendActivationCode

$result = $client->sendActivationCode([/* ... */]);
$promise = $client->sendActivationCodeAsync([/* ... */]);

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.

Parameter Syntax

$result = $client->sendActivationCode([
    'ContactChannelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To send an activation code

The following send-activation-code example sends an activation code and message to the specified contact channel.

$result = $client->sendActivationCode([
    'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400',
]);

Result syntax:

[
]

StartEngagement

$result = $client->startEngagement([/* ... */]);
$promise = $client->startEngagementAsync([/* ... */]);

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Parameter Syntax

$result = $client->startEngagement([
    'ContactId' => '<string>', // REQUIRED
    'Content' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>',
    'IncidentId' => '<string>',
    'PublicContent' => '<string>',
    'PublicSubject' => '<string>',
    'Sender' => '<string>', // REQUIRED
    'Subject' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EngagementArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: Example 1: To page a contact's contact channels

The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels. Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to track who started the engagement.

$result = $client->startEngagement([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
    'Content' => 'Testing engagements',
    'PublicContent' => 'Testing engagements',
    'PublicSubject' => 'test',
    'Sender' => 'tester',
    'Subject' => 'test',
]);

Result syntax:

[
    'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f',
]

Example 2: Example 2: To page a contact in the provided escalation plan.

The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their engagement plan.

$result = $client->startEngagement([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
    'Content' => 'Testing engagements',
    'PublicContent' => 'Testing engagements',
    'PublicSubject' => 'test',
    'Sender' => 'tester',
    'Subject' => 'test',
]);

Result syntax:

[
    'EngagementArn' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
]

StopEngagement

$result = $client->stopEngagement([/* ... */]);
$promise = $client->stopEngagementAsync([/* ... */]);

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

Parameter Syntax

$result = $client->stopEngagement([
    'EngagementId' => '<string>', // REQUIRED
    'Reason' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

Unexpected error occurred while processing the request.

Examples

Example 1: To stop an engagement

The following stop-engagement example stops an engagement from paging further contacts and contact channels.

$result = $client->stopEngagement([
    'EngagementId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
]);

Result syntax:

[
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource that doesn't exist.

InternalServerException:

Unexpected error occurred while processing the request.

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To tag a contact

The following tag-resource example tags a specified contact with the provided tag key value pair.

$result = $client->tagResource([
    'ResourceARN' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
    'Tags' => [
        [
            'Key' => 'group1',
            'Value' => '1',
        ],
    ],
]);

Result syntax:

[
]

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

Unexpected error occurred while processing the request.

Examples

Example 1: To remove tags from a contact

The following untag-resource example removes the group1 tag from the specified contact.

$result = $client->untagResource([
    'ResourceARN' => 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
    'TagKeys' => [
        'group1',
    ],
]);

Result syntax:

[
]

UpdateContact

$result = $client->updateContact([/* ... */]);
$promise = $client->updateContactAsync([/* ... */]);

Updates the contact or escalation plan specified.

Parameter Syntax

$result = $client->updateContact([
    'ContactId' => '<string>', // REQUIRED
    'DisplayName' => '<string>',
    'Plan' => [
        'RotationIds' => ['<string>', ...],
        'Stages' => [
            [
                'DurationInMinutes' => <integer>, // REQUIRED
                'Targets' => [ // REQUIRED
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => '<string>', // REQUIRED
                            'RetryIntervalInMinutes' => <integer>,
                        ],
                        'ContactTargetInfo' => [
                            'ContactId' => '<string>',
                            'IsEssential' => true || false, // REQUIRED
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

DataEncryptionException:

The operation failed to due an encryption key error.

Examples

Example 1: To update the engagement plan of contact

The following update-contact example updates the engagement plan of the contact Akua to include the three types of contacts channels. This is done after creating contact channels for Akua.

$result = $client->updateContact([
    'ContactId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
    'Plan' => [
        'Stages' => [
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65',
                            'RetryIntervalInMinutes' => 1,
                        ],
                    ],
                ],
            ],
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad',
                            'RetryIntervalInMinutes' => 1,
                        ],
                    ],
                ],
            ],
            [
                'DurationInMinutes' => 5,
                'Targets' => [
                    [
                        'ChannelTargetInfo' => [
                            'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a',
                            'RetryIntervalInMinutes' => 1,
                        ],
                    ],
                ],
            ],
        ],
    ],
]);

Result syntax:

[
]

UpdateContactChannel

$result = $client->updateContactChannel([/* ... */]);
$promise = $client->updateContactChannelAsync([/* ... */]);

Updates a contact's contact channel.

Parameter Syntax

$result = $client->updateContactChannel([
    'ContactChannelId' => '<string>', // REQUIRED
    'DeliveryAddress' => [
        'SimpleAddress' => '<string>',
    ],
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

DataEncryptionException:

The operation failed to due an encryption key error.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

Example 1: To update a contact channel

The following update-contact-channel example updates the name and delivery address of a contact channel.

$result = $client->updateContactChannel([
    'ContactChannelId' => 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad',
    'DeliveryAddress' => [
        'SimpleAddress' => '+15005550198',
    ],
    'Name' => 'akuas voice channel',
]);

Result syntax:

[
]

UpdateRotation

$result = $client->updateRotation([/* ... */]);
$promise = $client->updateRotationAsync([/* ... */]);

Updates the information specified for an on-call rotation.

Parameter Syntax

$result = $client->updateRotation([
    'ContactIds' => ['<string>', ...],
    'Recurrence' => [ // REQUIRED
        'DailySettings' => [
            [
                'HourOfDay' => <integer>, // REQUIRED
                'MinuteOfHour' => <integer>, // REQUIRED
            ],
            // ...
        ],
        'MonthlySettings' => [
            [
                'DayOfMonth' => <integer>, // REQUIRED
                'HandOffTime' => [ // REQUIRED
                    'HourOfDay' => <integer>, // REQUIRED
                    'MinuteOfHour' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
        'NumberOfOnCalls' => <integer>, // REQUIRED
        'RecurrenceMultiplier' => <integer>, // REQUIRED
        'ShiftCoverages' => [
            '<DayOfWeek>' => [
                [
                    'End' => [
                        'HourOfDay' => <integer>, // REQUIRED
                        'MinuteOfHour' => <integer>, // REQUIRED
                    ],
                    'Start' => [
                        'HourOfDay' => <integer>, // REQUIRED
                        'MinuteOfHour' => <integer>, // REQUIRED
                    ],
                ],
                // ...
            ],
            // ...
        ],
        'WeeklySettings' => [
            [
                'DayOfWeek' => 'MON|TUE|WED|THU|FRI|SAT|SUN', // REQUIRED
                'HandOffTime' => [ // REQUIRED
                    'HourOfDay' => <integer>, // REQUIRED
                    'MinuteOfHour' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'RotationId' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>,
    'TimeZoneId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this operation.

ConflictException:

Updating or deleting a resource causes an inconsistent state.

InternalServerException:

Unexpected error occurred while processing the request.

ResourceNotFoundException:

Request references a resource that doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.