createSubscription

Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. If the notification type that you specify supports multiple payload versions, you can use this operation to subscribe to a different payload version if you already have an existing subscription for a different payload version.

Usage Plan:

Rate (requests per second)Burst
15

The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Path Params
string
required

The type of notification.

For more information about notification types, refer to the Notifications API v1 Use Case Guide.

Body Params

The request schema for the createSubscription operation.

The request schema for the createSubscription operation.

string
required

The version of the payload object to be used in the notification.

string
required

The identifier for the destination where notifications will be delivered.

processingDirective
object

Additional information passed to the subscription to control the processing of notifications. For example, you can use an eventFilter to customize your subscription to send notifications for only the marketplaceIds that you specify, or select the aggregation time period at which to send notifications (for example, you can set a limit of one notification every five minutes for high frequency notifications). You can also use filterExpression to filter events based on notification payload. The specific features available can vary by the notificationType.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json
Successful Response