[ aws . connect ]

send-outbound-web-notification

Description

Sends an outbound web notification to a customer’s web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns .

Note

Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

See also: AWS API Documentation

Synopsis

  send-outbound-web-notification
--instance-id <value>
[--client-token <value>]
--browser-id <value>
--session-id <value>
--expires-at <value>
--source <value>
--destination <value>
--content <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--instance-id (string) [required]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Constraints:

• min: 1
• max: 100

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .

Constraints:

• max: 500

--browser-id (string) [required]

A unique identifier for the customer’s web browser instance to which the notification is being sent.

Constraints:

• min: 1
• max: 36

--session-id (string) [required]

A unique identifier for the customer’s web session to which the notification is being sent.

Constraints:

• min: 1
• max: 36

--expires-at (timestamp) [required]

The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer’s browser.

--source (structure) [required]

The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

SourceCampaign -> (structure) [required]

Information about the campaign that triggered the web notification, including the campaign identifier and outbound request identifier.

CampaignId -> (string)

A unique identifier for a campaign.

Constraints:

• min: 1
• max: 100

OutboundRequestId -> (string)

A unique identifier for a each request part of same campaign.

Constraints:

• min: 36
• max: 36

Shorthand Syntax:

SourceCampaign={CampaignId=string,OutboundRequestId=string}

JSON Syntax:

{
  "SourceCampaign": {
    "CampaignId": "string",
    "OutboundRequestId": "string"
  }
}

--destination (structure) [required]

The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

WidgetId -> (string) [required]

The identifier of the communication widget that delivers the notification to the customer’s browser.

Constraints:

• min: 1
• max: 36

ProfileId -> (string) [required]

The identifier of the customer profile associated with the browser session that should receive the notification.

Constraints:

• min: 1
• max: 32

Shorthand Syntax:

WidgetId=string,ProfileId=string

JSON Syntax:

{
  "WidgetId": "string",
  "ProfileId": "string"
}

--content (structure) [required]

The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

Type -> (string) [required]

The type of web notification to send.

Possible values:

• WIDGET_VIEW
• WIDGET_ACTION

ViewArn -> (string)

The Amazon Resource Name (ARN) of the view to render for the notification.

Constraints:

• min: 1
• max: 500

Attributes -> (structure)

Optional attributes used to populate the notification content, such as recommender configuration for personalized content.

RecommenderConfig -> (structure)

Configuration for the recommender used to generate personalized recommendations for the notification content.

DomainName -> (string) [required]

The name of the Amazon Personalize domain that hosts the recommender.

Constraints:

• min: 1
• max: 64

RecommenderName -> (string) [required]

The name of the recommender used to generate the recommendations.

Constraints:

• min: 1
• max: 64

Context -> (map)

A map of contextual key-value pairs supplied to the recommender to influence the recommendations returned.

key -> (string)

Constraints:

• min: 1
• max: 64

value -> (string)

Constraints:

• min: 1
• max: 255

JSON Syntax:

{
  "Type": "WIDGET_VIEW"|"WIDGET_ACTION",
  "ViewArn": "string",
  "Attributes": {
    "RecommenderConfig": {
      "DomainName": "string",
      "RecommenderName": "string",
      "Context": {"string": "string"
        ...}
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

None