AssociateChannel

$result = $client->associateChannel([/* ... */]);
$promise = $client->associateChannelAsync([/* ... */]);

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).

Parameter Syntax

$result = $client->associateChannel([
    'arn' => '<string>', // REQUIRED
    'notificationConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

CreateEventRule

$result = $client->createEventRule([/* ... */]);
$promise = $client->createEventRuleAsync([/* ... */]);

Creates an EventRule that is associated with a specified Notification Configuration.

Parameter Syntax

$result = $client->createEventRule([
    'eventPattern' => '<string>',
    'eventType' => '<string>', // REQUIRED
    'notificationConfigurationArn' => '<string>', // REQUIRED
    'regions' => ['<string>', ...], // REQUIRED
    'source' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'notificationConfigurationArn' => '<string>',
    'statusSummaryByRegion' => [
        '<Region>' => [
            'reason' => '<string>',
            'status' => 'ACTIVE|INACTIVE|CREATING|UPDATING|DELETING',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

CreateNotificationConfiguration

$result = $client->createNotificationConfiguration([/* ... */]);
$promise = $client->createNotificationConfigurationAsync([/* ... */]);

Creates a new NotificationConfiguration.

Parameter Syntax

$result = $client->createNotificationConfiguration([
    'aggregationDuration' => 'LONG|SHORT|NONE',
    'description' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'status' => 'ACTIVE|PARTIALLY_ACTIVE|INACTIVE|DELETING',
]

Result Details

Errors

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

DeleteEventRule

$result = $client->deleteEventRule([/* ... */]);
$promise = $client->deleteEventRuleAsync([/* ... */]);

Deletes an EventRule.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

DeleteNotificationConfiguration

$result = $client->deleteNotificationConfiguration([/* ... */]);
$promise = $client->deleteNotificationConfigurationAsync([/* ... */]);

Deletes a NotificationConfiguration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

DeregisterNotificationHub

$result = $client->deregisterNotificationHub([/* ... */]);
$promise = $client->deregisterNotificationHubAsync([/* ... */]);

Deregisters a NotificationHub in the specified Region.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'notificationHubRegion' => '<string>',
    'statusSummary' => [
        'reason' => '<string>',
        'status' => 'ACTIVE|REGISTERING|DEREGISTERING|INACTIVE',
    ],
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

DisassociateChannel

$result = $client->disassociateChannel([/* ... */]);
$promise = $client->disassociateChannelAsync([/* ... */]);

Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).

Parameter Syntax

$result = $client->disassociateChannel([
    'arn' => '<string>', // REQUIRED
    'notificationConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

GetEventRule

$result = $client->getEventRule([/* ... */]);
$promise = $client->getEventRuleAsync([/* ... */]);

Returns a specified EventRule.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'eventPattern' => '<string>',
    'eventType' => '<string>',
    'managedRules' => ['<string>', ...],
    'notificationConfigurationArn' => '<string>',
    'regions' => ['<string>', ...],
    'source' => '<string>',
    'statusSummaryByRegion' => [
        '<Region>' => [
            'reason' => '<string>',
            'status' => 'ACTIVE|INACTIVE|CREATING|UPDATING|DELETING',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

GetNotificationConfiguration

$result = $client->getNotificationConfiguration([/* ... */]);
$promise = $client->getNotificationConfigurationAsync([/* ... */]);

Returns a specified NotificationConfiguration.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'aggregationDuration' => 'LONG|SHORT|NONE',
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'name' => '<string>',
    'status' => 'ACTIVE|PARTIALLY_ACTIVE|INACTIVE|DELETING',
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

GetNotificationEvent

$result = $client->getNotificationEvent([/* ... */]);
$promise = $client->getNotificationEventAsync([/* ... */]);

Returns a specified NotificationEvent.

Parameter Syntax

$result = $client->getNotificationEvent([
    'arn' => '<string>', // REQUIRED
    'locale' => 'de_DE|en_CA|en_US|en_UK|es_ES|fr_CA|fr_FR|id_ID|it_IT|ja_JP|ko_KR|pt_BR|tr_TR|zh_CN|zh_TW',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'content' => [
        'aggregateNotificationEventArn' => '<string>',
        'aggregationEventType' => 'AGGREGATE|CHILD|NONE',
        'endTime' => <DateTime>,
        'eventStatus' => 'HEALTHY|UNHEALTHY',
        'id' => '<string>',
        'media' => [
            [
                'caption' => '<string>',
                'mediaId' => '<string>',
                'type' => 'IMAGE',
                'url' => '<string>',
            ],
            // ...
        ],
        'messageComponents' => [
            'completeDescription' => '<string>',
            'dimensions' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'headline' => '<string>',
            'paragraphSummary' => '<string>',
        ],
        'notificationType' => 'ALERT|WARNING|ANNOUNCEMENT|INFORMATIONAL',
        'schemaVersion' => 'v1.0',
        'sourceEventDetailUrl' => '<string>',
        'sourceEventDetailUrlDisplayText' => '<string>',
        'sourceEventMetadata' => [
            'eventOccurrenceTime' => <DateTime>,
            'eventOriginRegion' => '<string>',
            'eventType' => '<string>',
            'eventTypeVersion' => '<string>',
            'relatedAccount' => '<string>',
            'relatedResources' => [
                [
                    'arn' => '<string>',
                    'detailUrl' => '<string>',
                    'id' => '<string>',
                    'tags' => ['<string>', ...],
                ],
                // ...
            ],
            'source' => '<string>',
            'sourceEventId' => '<string>',
        ],
        'startTime' => <DateTime>,
        'textParts' => [
            '<TextPartId>' => [
                'displayText' => '<string>',
                'textByLocale' => ['<string>', ...],
                'type' => 'LOCALIZED_TEXT|PLAIN_TEXT|URL',
                'url' => '<string>',
            ],
            // ...
        ],
    ],
    'creationTime' => <DateTime>,
    'notificationConfigurationArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

ListChannels

$result = $client->listChannels([/* ... */]);
$promise = $client->listChannelsAsync([/* ... */]);

Returns a list of Channels for a NotificationConfiguration.

Parameter Syntax

$result = $client->listChannels([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'notificationConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'channels' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

ListEventRules

$result = $client->listEventRules([/* ... */]);
$promise = $client->listEventRulesAsync([/* ... */]);

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

Parameter Syntax

$result = $client->listEventRules([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'notificationConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'eventRules' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'eventPattern' => '<string>',
            'eventType' => '<string>',
            'managedRules' => ['<string>', ...],
            'notificationConfigurationArn' => '<string>',
            'regions' => ['<string>', ...],
            'source' => '<string>',
            'statusSummaryByRegion' => [
                '<Region>' => [
                    'reason' => '<string>',
                    'status' => 'ACTIVE|INACTIVE|CREATING|UPDATING|DELETING',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

ListNotificationConfigurations

$result = $client->listNotificationConfigurations([/* ... */]);
$promise = $client->listNotificationConfigurationsAsync([/* ... */]);

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

Parameter Syntax

$result = $client->listNotificationConfigurations([
    'channelArn' => '<string>',
    'eventRuleSource' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|PARTIALLY_ACTIVE|INACTIVE|DELETING',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'notificationConfigurations' => [
        [
            'aggregationDuration' => 'LONG|SHORT|NONE',
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'status' => 'ACTIVE|PARTIALLY_ACTIVE|INACTIVE|DELETING',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ListNotificationEvents

$result = $client->listNotificationEvents([/* ... */]);
$promise = $client->listNotificationEventsAsync([/* ... */]);

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

Parameter Syntax

$result = $client->listNotificationEvents([
    'aggregateNotificationEventArn' => '<string>',
    'endTime' => <integer || string || DateTime>,
    'includeChildEvents' => true || false,
    'locale' => 'de_DE|en_CA|en_US|en_UK|es_ES|fr_CA|fr_FR|id_ID|it_IT|ja_JP|ko_KR|pt_BR|tr_TR|zh_CN|zh_TW',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'source' => '<string>',
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'notificationEvents' => [
        [
            'aggregateNotificationEventArn' => '<string>',
            'aggregationEventType' => 'AGGREGATE|CHILD|NONE',
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'notificationConfigurationArn' => '<string>',
            'notificationEvent' => [
                'eventStatus' => 'HEALTHY|UNHEALTHY',
                'messageComponents' => [
                    'headline' => '<string>',
                ],
                'notificationType' => 'ALERT|WARNING|ANNOUNCEMENT|INFORMATIONAL',
                'schemaVersion' => 'v1.0',
                'sourceEventMetadata' => [
                    'eventOriginRegion' => '<string>',
                    'eventType' => '<string>',
                    'source' => '<string>',
                ],
            ],
            'relatedAccount' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ListNotificationHubs

$result = $client->listNotificationHubs([/* ... */]);
$promise = $client->listNotificationHubsAsync([/* ... */]);

Returns a list of NotificationHubs.

Parameter Syntax

$result = $client->listNotificationHubs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'notificationHubs' => [
        [
            'creationTime' => <DateTime>,
            'lastActivationTime' => <DateTime>,
            'notificationHubRegion' => '<string>',
            'statusSummary' => [
                'reason' => '<string>',
                'status' => 'ACTIVE|REGISTERING|DEREGISTERING|INACTIVE',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ListTagsForResource

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

Returns a list of tags for a specified Amazon Resource Name (ARN).

For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

RegisterNotificationHub

$result = $client->registerNotificationHub([/* ... */]);
$promise = $client->registerNotificationHubAsync([/* ... */]);

Registers a NotificationHub in the specified Region.

There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'lastActivationTime' => <DateTime>,
    'notificationHubRegion' => '<string>',
    'statusSummary' => [
        'reason' => '<string>',
        'status' => 'ACTIVE|REGISTERING|DEREGISTERING|INACTIVE',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

TagResource

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

Tags the resource with a tag key and value.

For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.

Parameter Syntax

$result = $client->tagResource([
    'arn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

UntagResource

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

Untags a resource with a specified Amazon Resource Name (ARN).

For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

UpdateEventRule

$result = $client->updateEventRule([/* ... */]);
$promise = $client->updateEventRuleAsync([/* ... */]);

Updates an existing EventRule.

Parameter Syntax

$result = $client->updateEventRule([
    'arn' => '<string>', // REQUIRED
    'eventPattern' => '<string>',
    'regions' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'notificationConfigurationArn' => '<string>',
    'statusSummaryByRegion' => [
        '<Region>' => [
            'reason' => '<string>',
            'status' => 'ACTIVE|INACTIVE|CREATING|UPDATING|DELETING',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

UpdateNotificationConfiguration

$result = $client->updateNotificationConfiguration([/* ... */]);
$promise = $client->updateNotificationConfigurationAsync([/* ... */]);

Updates a NotificationConfiguration.

Parameter Syntax

$result = $client->updateNotificationConfiguration([
    'aggregationDuration' => 'LONG|SHORT|NONE',
    'arn' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

User does not have sufficient access to perform this action.

ValidationException:

This exception is thrown when the notification event fails validation.

InternalServerException:

Unexpected error during processing of request.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.