Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutNotificationSettings

Attaches a list of notification settings to a trust anchor.

A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.

Required permissions: rolesanywhere:PutNotificationSettings.

Request Syntax


PATCH /put-notifications-settings HTTP/1.1
Content-type: application/json

{
   "notificationSettings": [ 
      { 
         "channel": "string",
         "enabled": boolean,
         "event": "string",
         "threshold": number
      }
   ],
   "trustAnchorId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

notificationSettings

A list of notification settings to be associated to the trust anchor.

Type: Array of NotificationSetting objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: Yes

trustAnchorId

The unique identifier of the trust anchor.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "trustAnchor": { 
      "createdAt": "string",
      "enabled": boolean,
      "name": "string",
      "notificationSettings": [ 
         { 
            "channel": "string",
            "configuredBy": "string",
            "enabled": boolean,
            "event": "string",
            "threshold": number
         }
      ],
      "source": { 
         "sourceData": { ... },
         "sourceType": "string"
      },
      "trustAnchorArn": "string",
      "trustAnchorId": "string",
      "updatedAt": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

trustAnchor

The state of the trust anchor after a read or write operation.

Type: TrustAnchorDetail object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404

ValidationException

Validation exception error.

HTTP Status Code: 400