notification¶
notification smtpserver get¶
Usage
usage: -c notification smtpserver get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Returns the Smtp server configuration.
Return
Returns dict: OK
Optional
optional arguments:
-h, --help show this help message and exit
notification smtpserver update¶
Usage
usage: -c notification smtpserver update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--username USERNAME]
[--from-address FROM_ADDRESS]
[--server-name SERVER_NAME]
[--enable-tls ENABLE_TLS]
[--password PASSWORD]
[--server-port SERVER_PORT]
Description
Set the configuration of the Smtp server.
Return
Returns dict: OK
Optional
optional arguments:
-h, --help show this help message and exit
--username USERNAME If the account requires authentication, this parameter is used to set the username.
--from-address FROM_ADDRESS
The email address that will appear in the from field of the emails sent by the notification service. The email address must have valid syntax (for example, notifications@symphony.com or noreply@symphony.com).
--server-name SERVER_NAME
The name of the Smtp server
--enable-tls ENABLE_TLS
Determines if the connection to the server is encrypted.
--password PASSWORD If the account requires authentication, this parameter is used to set the password.
--server-port SERVER_PORT
Set when the Smtp server is not using port 25/
notification subscriptions delete¶
Usage
usage: -c notification subscriptions delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
subscription_id
Description
Deletes a subscription.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
notification subscriptions get-attributes¶
Usage
usage: -c notification subscriptions get-attributes [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
subscription_id
Description
Returns all of the properties of a subscription.
Return
Returns dict: OK
Optional
optional arguments:
-h, --help show this help message and exit
notification subscriptions list¶
Usage
usage: -c notification subscriptions list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user-id USER_ID]
[--account-id ACCOUNT_ID]
[--topic-id TOPIC_ID]
[--sort-by SORT_BY] [--limit LIMIT]
[--offset OFFSET]
[--project-id PROJECT_ID]
[--order ORDER]
Description
Returns a list of subscriptions.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--user-id USER_ID ID of a user
--account-id ACCOUNT_ID
ID of an account
--topic-id TOPIC_ID The unique ID of a topic.
--sort-by SORT_BY The field by which to sort
--limit LIMIT Specify the number of entities that you want to retrieve
--offset OFFSET Specify the first entity that you wan to retrieve
--project-id PROJECT_ID
ID of a project
--order ORDER The sorting order for get response
notification subscriptions set-attributes¶
Usage
usage: -c notification subscriptions set-attributes [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--value VALUE]
subscription_id name
Description
Allows a subscription owner to set an attribute of the topic to a new value.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--value VALUE The value of the attribute.
notification topics add-permission¶
Usage
usage: -c notification topics add-permission [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project-ids [PROJECT_IDS [PROJECT_IDS ...]]]
[--actions [ACTIONS [ACTIONS ...]]]
[--label LABEL]
topic_id
Description
Adds a statement to a topic’s access control policy, granting access for the specified project to the specified actions.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--project-ids [PROJECT_IDS [PROJECT_IDS ...]]
The IDs of the projects who will be given access to the specified actions.
--actions [ACTIONS [ACTIONS ...]]
The action you want to allow for the specified principal(s).
--label LABEL A unique identifier for the new policy statement.
notification topics confirm-subscription¶
Usage
usage: -c notification topics confirm-subscription [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
topic_id
Description
Verifies an endpoint owner’s intent to receive messages by validating the token sent to the endpoint by an earlier subscribe action. If the token is valid, the action creates a new subscription and returns its identifier.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
notification topics create¶
Usage
usage: -c notification topics create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
topic_name
Description
Creates a topic to which notifications can be published. This action is idempotent, so if the requester already owns a topic with the specified name, that topic’s ID is returned without creating a new topic.
Return
Returns dict: OK
Optional
optional arguments:
-h, --help show this help message and exit
notification topics delete¶
Usage
usage: -c notification topics delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
topic_id
Description
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
notification topics get-attributes¶
Usage
usage: -c notification topics get-attributes [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
topic_id
Description
Returns all of the properties of a topic.
Return
Returns dict: OK
Optional
optional arguments:
-h, --help show this help message and exit
notification topics get-subscriptions¶
Usage
usage: -c notification topics get-subscriptions [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
topic_id
Description
Returns all of the subscriptions of a topic.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
notification topics list¶
Usage
usage: -c notification topics list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user-id USER_ID]
[--account-id ACCOUNT_ID]
[--sort-by SORT_BY] [--id-eq ID_EQ]
[--limit LIMIT] [--offset OFFSET]
[--project-id PROJECT_ID] [--order ORDER]
[--name NAME]
Description
Returns list: ok
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--user-id USER_ID ID of a user
--account-id ACCOUNT_ID
ID of an account
--sort-by SORT_BY The field by which to sort
--id-eq ID_EQ ids of topics to filter, for multilpe use commas (e.g 111,222,333)
--limit LIMIT Specify the number of entities that you want to retrieve
--offset OFFSET Specify the first entity that you want to retrieve
--project-id PROJECT_ID
ID of a project
--order ORDER The sorting order for get response
--name NAME The name of a topic.
notification topics publish¶
Usage
usage: -c notification topics publish [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--message-attributes [MESSAGE_ATTRIBUTES [MESSAGE_ATTRIBUTES ...]]]
[--message-structure MESSAGE_STRUCTURE]
[--subject SUBJECT]
message topic_id
Description
Sends a message to all of a topic’s subscribed endpoints. When a messageId is returned, the message has been saved and the notification service will attempt to deliver it to the topic’s subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--message-attributes [MESSAGE_ATTRIBUTES [MESSAGE_ATTRIBUTES ...]]
--message-structure MESSAGE_STRUCTURE
Set to json if you want to send a different message for each protocol.
--subject SUBJECT Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
notification topics revoke-permissions¶
Usage
usage: -c notification topics revoke-permissions [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
label topic_id
Description
Removes a statement from a topic’s access control policy.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
notification topics set-attributes¶
Usage
usage: -c notification topics set-attributes [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--value VALUE]
name topic_id
Description
Allows a topic owner to set an attribute of the topic to a new value.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--value VALUE The value of the attribute.
notification topics subscribe¶
Usage
usage: -c notification topics subscribe [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
endpoint protocol topic_id
Description
Prepares to subscribe a notification-endpoint by sending the notification-endpoint a confirmation message. To actually create a subscription, the notification-endpoint owner must call the confirm-subscription action with the token from the confirmation message.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit