SDK for PHP 3.x

AWS User Notifications Contacts 2018-05-10

Client: Aws\NotificationsContacts\NotificationsContactsClient
Service ID: notificationscontacts
Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS User Notifications Contacts (2018-05-10), and shows how to use the Aws\NotificationsContacts\NotificationsContactsClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ActivateEmailContact ( array $params = [] )
Activates an email contact using an activation code.
CreateEmailContact ( array $params = [] )
Creates an email contact for the provided email address.
DeleteEmailContact ( array $params = [] )
Deletes an email contact.
GetEmailContact ( array $params = [] )
Returns an email contact.
ListEmailContacts ( array $params = [] )
Lists all email contacts created under the Account.
ListTagsForResource ( array $params = [] )
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
SendActivationCode ( array $params = [] )
Sends an activation email to the email address associated with the specified email contact.
TagResource ( array $params = [] )
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
UntagResource ( array $params = [] )
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListEmailContacts

Operations

ActivateEmailContact 

$result = $client->activateEmailContact([/* ... */]);
$promise = $client->activateEmailContactAsync([/* ... */]);

Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact.

Parameter Syntax

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

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

code
Required: Yes
Type: string

The activation code for this email contact.

An email contact has a maximum of five activation attempts. Activation codes expire after 12 hours and are generated by the SendActivationCode API action.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

Unexpected error during processing of request.

ResourceNotFoundException:

Your request references a resource which does not exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

CreateEmailContact 

$result = $client->createEmailContact([/* ... */]);
$promise = $client->createEmailContactAsync([/* ... */]);

Creates an email contact for the provided email address.

Parameter Syntax

$result = $client->createEmailContact([
    'emailAddress' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
emailAddress
Required: Yes
Type: string

The email address this email contact points to. The activation email and any subscribed emails are sent here.

This email address can't receive emails until it's activated.

name
Required: Yes
Type: string

The name of the email contact.

tags
Type: Associative array of custom strings keys (TagKey) to strings

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Errors

InternalServerException:

Unexpected error during processing of request.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException:

Request would cause a service quota to be exceeded.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

DeleteEmailContact 

$result = $client->deleteEmailContact([/* ... */]);
$promise = $client->deleteEmailContactAsync([/* ... */]);

Deletes an email contact.

Deleting an email contact removes it from all associated notification configurations.

Parameter Syntax

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

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

Unexpected error during processing of request.

ResourceNotFoundException:

Your request references a resource which does not exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

GetEmailContact 

$result = $client->getEmailContact([/* ... */]);
$promise = $client->getEmailContactAsync([/* ... */]);

Returns an email contact.

Parameter Syntax

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

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the email contact to get.

Result Syntax

[
    'emailContact' => [
        'address' => '<string>',
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'name' => '<string>',
        'status' => 'inactive|active',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
emailContact
Required: Yes
Type: EmailContact structure

The email contact for the provided email address.

Errors

InternalServerException:

Unexpected error during processing of request.

ResourceNotFoundException:

Your request references a resource which does not exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ListEmailContacts 

$result = $client->listEmailContacts([/* ... */]);
$promise = $client->listEmailContactsAsync([/* ... */]);

Lists all email contacts created under the Account.

Parameter Syntax

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

Parameter Details

Members
maxResults
Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
Type: string

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Result Syntax

[
    'emailContacts' => [
        [
            'address' => '<string>',
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'name' => '<string>',
            'status' => 'inactive|active',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
emailContacts
Required: Yes
Type: Array of EmailContact structures

A list of email contacts.

nextToken
Type: string

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Errors

InternalServerException:

Unexpected error during processing of request.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ListTagsForResource 

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

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

Parameter Syntax

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

Parameter Details

Members
arn
Required: Yes
Type: string

The ARN you specified to list the tags of.

Result Syntax

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

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

Errors

InternalServerException:

Unexpected error during processing of request.

ResourceNotFoundException:

Your request references a resource which does not exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

SendActivationCode 

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

Sends an activation email to the email address associated with the specified email contact.

It might take a few minutes for the activation email to arrive. If it doesn't arrive, check in your spam folder or try sending another activation email.

Parameter Syntax

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

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

Unexpected error during processing of request.

ResourceNotFoundException:

Your request references a resource which does not exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

TagResource 

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

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.

Parameter Syntax

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

Parameter Details

Members
arn
Required: Yes
Type: string

The ARN of the configuration.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to apply to the configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

Unexpected error during processing of request.

ResourceNotFoundException:

Your request references a resource which does not exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

UntagResource 

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

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts..

Parameter Syntax

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

Parameter Details

Members
arn
Required: Yes
Type: string

The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

tagKeys
Required: Yes
Type: Array of strings

Specifies a list of tag keys that you want to remove from the specified resources.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

Unexpected error during processing of request.

ResourceNotFoundException:

Your request references a resource which does not exist.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

ConflictException

Description

Updating or deleting a resource can cause an inconsistent state.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The resource ID that prompted the conflict error.

resourceType
Required: Yes
Type: string

The resource type that prompted the conflict error.

EmailContact

Description

An email contact.

Members
address
Required: Yes
Type: string

The email address this email contact points to. The activation email and any subscribed emails are sent here.

arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the email contact.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the resource.

name
Required: Yes
Type: string

The name of the email contact.

status
Required: Yes
Type: string

The status of the email contact. Only activated email contacts receive emails.

updateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the resource was last updated.

InternalServerException

Description

Unexpected error during processing of request.

Members
message
Required: Yes
Type: string

ResourceNotFoundException

Description

Your request references a resource which does not exist.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The ID of the resource that wasn't found.

resourceType
Required: Yes
Type: string

The type of resource that wasn't found.

ServiceQuotaExceededException

Description

Request would cause a service quota to be exceeded.

Members
message
Required: Yes
Type: string
quotaCode
Required: Yes
Type: string

The code for the service quota in Service Quotas.

resourceId
Required: Yes
Type: string

The ID of the resource that exceeds the service quota.

resourceType
Required: Yes
Type: string

The type of the resource that exceeds the service quota.

serviceCode
Required: Yes
Type: string

The code for the service quota exceeded in Service Quotas.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string
quotaCode
Type: string

Identifies the quota that is being throttled.

retryAfterSeconds
Type: int

The number of seconds a client should wait before retrying the request.

serviceCode
Type: string

Identifies the service being throttled.

ValidationException

Description

The input fails to satisfy the constraints specified by an AWS service.

Members
fieldList
Type: Array of ValidationExceptionField structures

The list of input fields that are invalid.

message
Required: Yes
Type: string
reason
Required: Yes
Type: string

The reason why your input is considered invalid.

ValidationExceptionField

Description

Stores information about a field passed inside a request that resulted in an exception.

Members
message
Required: Yes
Type: string

A message with the reason for the validation exception error.

name
Required: Yes
Type: string

The field name where the invalid entry was detected.