AWS CLI Command Reference

[ aws . dataexchange ]

send-data-set-notification

Description

The type of event associated with the data set.

See also: AWS API Documentation

Synopsis

  send-data-set-notification
[--scope <value>]
[--client-token <value>]
[--comment <value>]
--data-set-id <value>
[--details <value>]
--type <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]

Options

--scope (structure)

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

LakeFormationTagPolicies -> (list)

Underlying LF resources that will be affected by this notification.

(structure)

Extra details specific to the affected scope in this LF data set.

Database -> (string)

The underlying Glue database that the notification is referring to.

Table -> (string)

The underlying Glue table that the notification is referring to.

RedshiftDataShares -> (list)

Underlying Redshift resources that will be affected by this notification.

(structure)

Extra details specific to the affected scope in this Redshift data set.

Arn -> (string)

The ARN of the underlying Redshift data share that is being affected by this notification.

Database -> (string)

The database name in the Redshift data share that is being affected by this notification.

Function -> (string)

A function name in the Redshift database that is being affected by this notification.

Table -> (string)

A table name in the Redshift database that is being affected by this notification.

Schema -> (string)

A schema name in the Redshift database that is being affected by this notification.

View -> (string)

A view name in the Redshift database that is being affected by this notification.

S3DataAccesses -> (list)

Underlying S3 resources that will be affected by this notification.

(structure)

Extra details specific to the affected scope in this S3 Data Access data set.

KeyPrefixes -> (list)

A list of the key prefixes affected by this notification. This can have up to 50 entries.

(string)

Keys -> (list)

A list of the keys affected by this notification. This can have up to 50 entries.

(string)

JSON Syntax:

{
  "LakeFormationTagPolicies": [
    {
      "Database": "string",
      "Table": "string"
    }
    ...
  ],
  "RedshiftDataShares": [
    {
      "Arn": "string",
      "Database": "string",
      "Function": "string",
      "Table": "string",
      "Schema": "string",
      "View": "string"
    }
    ...
  ],
  "S3DataAccesses": [
    {
      "KeyPrefixes": ["string", ...],
      "Keys": ["string", ...]
    }
    ...
  ]
}

--client-token (string)

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

--comment (string)

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

--data-set-id (string)

Affected data set of the notification.

--details (structure)

Extra details specific to this notification type.

DataUpdate -> (structure)

Extra details specific to a data update type notification.

DataUpdatedAt -> (timestamp)

A datetime in the past when the data was updated. This typically means that the underlying resource supporting the data set was updated.

Deprecation -> (structure)

Extra details specific to a deprecation type notification.

DeprecationAt -> (timestamp)

A datetime in the future when the data set will be deprecated.

SchemaChange -> (structure)

Extra details specific to a schema change type notification.

Changes -> (list)

List of schema changes happening in the scope of this notification. This can have up to 100 entries.

(structure)

Object encompassing information about a schema change to a single, particular field, a notification can have up to 100 of these.

Name -> (string)

Name of the changing field. This value can be up to 255 characters long.

Type -> (string)

Is the field being added, removed, or modified?

Description -> (string)

Description of what’s changing about this field. This value can be up to 512 characters long.

SchemaChangeAt -> (timestamp)

A date in the future when the schema change is taking effect.

JSON Syntax:

{
  "DataUpdate": {
    "DataUpdatedAt": timestamp
  },
  "Deprecation": {
    "DeprecationAt": timestamp
  },
  "SchemaChange": {
    "Changes": [
      {
        "Name": "string",
        "Type": "ADD"|"REMOVE"|"MODIFY",
        "Description": "string"
      }
      ...
    ],
    "SchemaChangeAt": timestamp
  }
}

--type (string)

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

Possible values:

  • DATA_DELAY
  • DATA_UPDATE
  • DEPRECATION
  • SCHEMA_CHANGE

--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

--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.

Output

None

© Copyright 2018, Amazon Web Services. Created using Sphinx.