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

SendDataSetNotification

The type of event associated with the data set.

Request Syntax


POST /v1/data-sets/DataSetId/notification HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Comment": "string",
   "Details": { 
      "DataUpdate": { 
         "DataUpdatedAt": "string"
      },
      "Deprecation": { 
         "DeprecationAt": "string"
      },
      "SchemaChange": { 
         "Changes": [ 
            { 
               "Description": "string",
               "Name": "string",
               "Type": "string"
            }
         ],
         "SchemaChangeAt": "string"
      }
   },
   "Scope": { 
      "LakeFormationTagPolicies": [ 
         { 
            "Database": "string",
            "Table": "string"
         }
      ],
      "RedshiftDataShares": [ 
         { 
            "Arn": "string",
            "Database": "string",
            "Function": "string",
            "Schema": "string",
            "Table": "string",
            "View": "string"
         }
      ],
      "S3DataAccesses": [ 
         { 
            "KeyPrefixes": [ "string" ],
            "Keys": [ "string" ]
         }
      ]
   },
   "Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DataSetId

Affected data set of the notification.

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientToken

Idempotency key for the notification, this key allows us to deduplicate notifications that are sent in quick succession erroneously.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\x21-\x7E]{1,64}

Required: No

Comment

Free-form text field for providers to add information about their notifications.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

Details

Extra details specific to this notification type.

Type: NotificationDetails object

Required: No

Scope

Affected scope of this notification such as the underlying resources affected by the notification event.

Type: ScopeDetails object

Required: No

Type

The type of the notification. Describing the kind of event the notification is alerting you to.

Type: String

Valid Values: DATA_DELAY | DATA_UPDATE | DEPRECATION | SCHEMA_CHANGE

Required: Yes

Response Syntax


HTTP/1.1 202

Response Elements

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

Errors

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

AccessDeniedException

Access to the resource is denied.

HTTP Status Code: 403

ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

HTTP Status Code: 409

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request was invalid.

HTTP Status Code: 400