|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/sns/__pycache__/ |
Upload File : |
o
ckF[�� � @ sP d dl Z d dlZd dlmZ d dlmZ d dlmZ d dlZG dd� de�Z dS )� N)�AWSQueryConnection)�
RegionInfo)�jsonc sp e Zd ZdZej�ddd�Zej�ddd�Zej�ddd�Z
dG� fd
d� Z
dd� Z dd� Z dHdd�Z
dd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dId!d"�Zd#d$� Zd%d&� Z 'dJd(d)�Zd*d+� ZdHd,d-�ZdHd.d/�Z dKd0d1�Z dLd2d3�Z dHd4d5�Z dHd6d7�Z dLd8d9�Z dHd:d;�Z dMd<d=�Z!dHd>d?�Z"dLd@dA�Z#dHdBdC�Z$dNdEdF�Z%� Z&S )O�
SNSConnectiona�
Amazon Simple Notification Service
Amazon Simple Notification Service (Amazon SNS) is a web service
that enables you to build distributed web-enabled applications.
Applications can use Amazon SNS to easily push real-time
notification messages to interested subscribers over multiple
delivery protocols. For more information about this product see
`http://aws.amazon.com/sns`_. For detailed information about
Amazon SNS features and their associated API calls, see the
`Amazon SNS Developer Guide`_.
We also provide SDKs that enable you to access Amazon SNS from
your preferred programming language. The SDKs contain
functionality that automatically takes care of tasks such as:
cryptographically signing your service requests, retrying
requests, and handling error responses. For a list of available
SDKs, go to `Tools for Amazon Web Services`_.
�Boto�sns_region_namez us-east-1�sns_region_endpointzsns.us-east-1.amazonaws.com� sns_versionz
2010-03-31NTr �/c sT | s t | | j| jtd�} | | _tt| �j||||||||| jj| |
| |
||d� d S )N)�connection_cls)�security_token�validate_certs� profile_name)r �DefaultRegionName�DefaultRegionEndpointr �region�super�__init__�endpoint)�self�aws_access_key_id�aws_secret_access_key� is_secure�port�proxy�
proxy_port�
proxy_user�
proxy_pass�debug�https_connection_factoryr �pathr r
r �� __class__� �5/usr/lib/python3/dist-packages/boto/sns/connection.pyr 9 s �
�zSNSConnection.__init__c
C sj t |�� dd� d�}t|ttdt|�d ���D ]\}}|\}}d||f } ||d| < ||d| < qdS ) aA
Serialize a parameter 'name' which value is a 'dictionary' into a list of parameters.
See: http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
For example::
dictionary = {'PlatformPrincipal': 'foo', 'PlatformCredential': 'bar'}
name = 'Attributes'
would result in params dict being populated with:
Attributes.entry.1.key = PlatformPrincipal
Attributes.entry.1.value = foo
Attributes.entry.2.key = PlatformCredential
Attributes.entry.2.value = bar
:param params: the resulting parameters will be added to this dict
:param dictionary: dict - value of the serialized parameter
:param name: name of the serialized parameter
c S s | d S )Nr r# )�xr# r# r$ �<lambda>b s z:SNSConnection._build_dict_as_list_params.<locals>.<lambda>)�key� z %s.entry.%sz%s.keyz%s.valueN)�sorted�items�zip�list�range�len)
r �params�
dictionary�namer* �kv�indexr' �value�prefixr# r# r$ �_build_dict_as_list_paramsN s $ �z(SNSConnection._build_dict_as_list_paramsc C s dgS )Nzhmac-v4r# )r r# r# r$ �_required_auth_capabilityi s z'SNSConnection._required_auth_capabilityc C � i }|r||d< | � d|�S )z�
:type next_token: string
:param next_token: Token returned by the previous call to
this method.
� NextToken�
ListTopics��
_make_request�r �
next_tokenr/ r# r# r$ �get_all_topicsl s z SNSConnection.get_all_topicsc C � d|i}| � d|�S )zu
Get attributes of a Topic
:type topic: string
:param topic: The ARN of the topic.
�TopicArn�GetTopicAttributesr; �r �topicr/ r# r# r$ �get_topic_attributesx � z"SNSConnection.get_topic_attributesc C � |||d�}| � d|�S )a�
Get attributes of a Topic
:type topic: string
:param topic: The ARN of the topic.
:type attr_name: string
:param attr_name: The name of the attribute you want to set.
Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName
:type attr_value: string
:param attr_value: The new value for the attribute.
)rA �
AttributeName�AttributeValue�SetTopicAttributesr; )r rD � attr_name�
attr_valuer/ r# r# r$ �set_topic_attributes� s
� z"SNSConnection.set_topic_attributesc C s2 ||d�}| � ||d� | � ||d� | �d|�S )a�
Adds a statement to a topic's access control policy, granting
access for the specified AWS accounts to the specified actions.
:type topic: string
:param topic: The ARN of the topic.
:type label: string
:param label: A unique identifier for the new policy statement.
:type account_ids: list of strings
:param account_ids: The AWS account ids of the users who will be
give access to the specified actions.
:type actions: list of strings
:param actions: The actions you want to allow for each of the
specified principal(s).
�rA �LabelzAWSAccountId.memberzActionName.member�
AddPermission)�build_list_paramsr< )r rD �label� account_ids�actionsr/ r# r# r$ �add_permission� s � z SNSConnection.add_permissionc C s ||d�}| � d|�S )a
Removes a statement from a topic's access control policy.
:type topic: string
:param topic: The ARN of the topic.
:type label: string
:param label: A unique identifier for the policy statement
to be removed.
rN �RemovePermissionr; )r rD rR r/ r# r# r$ �remove_permission� s � z SNSConnection.remove_permissionc C r@ )zt
Create a new Topic.
:type topic: string
:param topic: The name of the new topic.
�Name� CreateTopicr; rC r# r# r$ � create_topic� rF zSNSConnection.create_topicc C s d|i}| � d|dd�S )zs
Delete an existing topic
:type topic: string
:param topic: The ARN of the topic
rA � DeleteTopicr
�GETr; rC r# r# r$ � delete_topic� s zSNSConnection.delete_topicc C s� |du rt d��d|i}|dur||d< |dur ||d< |dur$||d< |dur,||d< |durst|�� �}t|dd �D ]6\} }
||
} |
|d
�| �< d | v rX| d |d �| �< d
| v re| d
|d�| �< d| v rr| d |d�| �< q<| �d|dd�S )a{
Sends a message to all of a topic's subscribed endpoints
:type topic: string
:param topic: The topic you want to publish to.
:type message: string
:param message: The message you want to send to the topic.
Messages must be UTF-8 encoded strings and
be at most 4KB in size.
:type message_structure: string
:param message_structure: Optional parameter. If left as ``None``,
plain text will be sent. If set to ``json``,
your message should be a JSON string that
matches the structure described at
http://docs.aws.amazon.com/sns/latest/dg/PublishTopic.html#sns-message-formatting-by-protocol
:type message_attributes: dict
:param message_attributes: Message attributes to set. Should be
of the form:
.. code-block:: python
{
"name1": {
"data_type": "Number",
"string_value": "42"
},
"name2": {
"data_type": "String",
"string_value": "Bob"
}
}
:type subject: string
:param subject: Optional parameter to be used as the "Subject"
line of the email notifications.
:type target_arn: string
:param target_arn: Optional parameter for either TopicArn or
EndpointArn, but not both.
Nz!'message' is a required parameter�Message�SubjectrA � TargetArn�MessageStructurer( )�startz MessageAttributes.entry.{0}.Name� data_typez*MessageAttributes.entry.{0}.Value.DataType� string_valuez-MessageAttributes.entry.{0}.Value.StringValue� binary_valuez-MessageAttributes.entry.{0}.Value.BinaryValue�Publishr
�POST)� TypeErrorr) �keys� enumerate�formatr< ) r rD �message�subject�
target_arn�message_structure�message_attributesr/ ri �ir1 � attributer# r# r$ �publish� s6 . � � ��zSNSConnection.publishc C rG )aU
Subscribe to a Topic.
:type topic: string
:param topic: The ARN of the new topic.
:type protocol: string
:param protocol: The protocol used to communicate with
the subscriber. Current choices are:
email|email-json|http|https|sqs|sms|application
:type endpoint: string
:param endpoint: The location of the endpoint for
the subscriber.
* For email, this would be a valid email address
* For email-json, this would be a valid email address
* For http, this would be a URL beginning with http
* For https, this would be a URL beginning with https
* For sqs, this would be the ARN of an SQS Queue
* For sms, this would be a phone number of an
SMS-enabled device
* For application, the endpoint is the EndpointArn
of a mobile app and device.
)rA �Protocol�Endpoint� Subscriber; )r rD �protocolr r/ r# r# r$ � subscribe$ s
� zSNSConnection.subscribec C s� |j �d�}|j}t�|| �d���� }d}| �|d|�}|�d�}d|v r/t �
|d �} ni } d| vr9d| d< d| vrAg | d< | d D ]
}
|
d |krOd
}qE|shd d d
di||dd|iid�} | d � | � |� dt �
| �� |S )a�
Subscribe an SQS queue to a topic.
This is convenience method that handles most of the complexity involved
in using an SQS queue as an endpoint for an SNS topic. To achieve this
the following operations are performed:
* The correct ARN is constructed for the SQS queue and that ARN is
then subscribed to the topic.
* A JSON policy document is contructed that grants permission to
the SNS topic to send messages to the SQS queue.
* This JSON policy is then associated with the SQS queue using
the queue's set_attribute method. If the queue already has
a policy associated with it, this process will add a Statement to
that policy. If no policy exists, a new policy will be created.
:type topic: string
:param topic: The ARN of the new topic.
:type queue: A boto Queue object
:param queue: The queue you wish to subscribe to the SNS Topic.
r
�utf-8F�sqs�Policy�Versionz
2008-10-17� Statement�SidTzSQS:SendMessage�Allow�AWS�*�
StringLikez
aws:SourceArn)�Action�Effect� Principal�Resourcer~ � Condition)�id�split�arn�hashlib�md5�encode� hexdigestrx �get_attributesr �loads�append�
set_attribute�dumps) r rD �queue�t�q_arn�sid�
sid_exists�resp�attr�policy�s� statementr# r# r$ �subscribe_sqs_queueB s8
�
�z!SNSConnection.subscribe_sqs_queueFc C s" ||d�}|r d|d< | � d|�S )aU
Get properties of a Topic
:type topic: string
:param topic: The ARN of the new topic.
:type token: string
:param token: Short-lived token sent to and endpoint during
the Subscribe operation.
:type authenticate_on_unsubscribe: bool
:param authenticate_on_unsubscribe: Optional parameter indicating
that you wish to disable
unauthenticated unsubscription
of the subscription.
)rA �Token�true�AuthenticateOnUnsubscribe�ConfirmSubscriptionr; )r rD �token�authenticate_on_unsubscriber/ r# r# r$ �confirm_subscriptionv s
z"SNSConnection.confirm_subscriptionc C r@ )z�
Allows endpoint owner to delete subscription.
Confirmation message will be delivered.
:type subscription: string
:param subscription: The ARN of the subscription to be deleted.
�SubscriptionArn� Unsubscriber; )r � subscriptionr/ r# r# r$ � unsubscribe� s zSNSConnection.unsubscribec C r8 )z�
Get list of all subscriptions.
:type next_token: string
:param next_token: Token returned by the previous call to
this method.
r9 �ListSubscriptionsr; r= r# r# r$ �get_all_subscriptions� s z#SNSConnection.get_all_subscriptionsc C s d|i}|r
||d< | � d|�S )aY
Get list of all subscriptions to a specific topic.
:type topic: string
:param topic: The ARN of the topic for which you wish to
find subscriptions.
:type next_token: string
:param next_token: Token returned by the previous call to
this method.
rA r9 �ListSubscriptionsByTopicr; )r rD r> r/ r# r# r$ � get_all_subscriptions_by_topic� s
z,SNSConnection.get_all_subscriptions_by_topicc C sH i }|dur
||d< |dur||d< |dur | � ||d� | jd|d�S )a�
The `CreatePlatformApplication` action creates a platform
application object for one of the supported push notification
services, such as APNS and GCM, to which devices and mobile
apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the
`CreatePlatformApplication` action. The PlatformPrincipal is
received from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is "SSL certificate". For GCM,
PlatformPrincipal is not applicable. For ADM,
PlatformPrincipal is "client id". The PlatformCredential is
also received from the notification service. For
APNS/APNS_SANDBOX, PlatformCredential is "private key". For
GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret". The
PlatformApplicationArn that is returned when using
`CreatePlatformApplication` is then used as an attribute for
the `CreatePlatformEndpoint` action. For more information, see
`Using Amazon SNS Mobile Push Notifications`_.
:type name: string
:param name: Application names must be made up of only uppercase and
lowercase ASCII letters, numbers, underscores, hyphens, and
periods, and must be between 1 and 256 characters long.
:type platform: string
:param platform: The following platforms are supported: ADM (Amazon
Device Messaging), APNS (Apple Push Notification Service),
APNS_SANDBOX, and GCM (Google Cloud Messaging).
:type attributes: map
:param attributes: For a list of attributes, see
`SetPlatformApplicationAttributes`_
NrX �Platform�
Attributes�CreatePlatformApplication��actionr/ �r6 r< )r r1 �platform�
attributesr/ r# r# r$ �create_platform_application� s %�z)SNSConnection.create_platform_applicationc C �8 i }|dur
||d< |dur| � ||d� | jd|d�S )a�
The `SetPlatformApplicationAttributes` action sets the
attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
For more information, see `Using Amazon SNS Mobile Push
Notifications`_.
:type platform_application_arn: string
:param platform_application_arn: PlatformApplicationArn for
SetPlatformApplicationAttributes action.
:type attributes: map
:param attributes:
A map of the platform application attributes. Attributes in this map
include the following:
+ `PlatformCredential` -- The credential received from the notification
service. For APNS/APNS_SANDBOX, PlatformCredential is "private
key". For GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret".
+ `PlatformPrincipal` -- The principal received from the notification
service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL
certificate". For GCM, PlatformPrincipal is not applicable. For
ADM, PlatformPrincipal is "client id".
+ `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
notifications should be sent.
+ `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
notifications should be sent.
+ `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
notifications should be sent.
+ `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
notifications should be sent upon Direct Publish delivery failure
(permanent) to one of the application's endpoints.
N�PlatformApplicationArnr� � SetPlatformApplicationAttributesr� r� )r �platform_application_arnr� r/ r# r# r$ �#set_platform_application_attributes� s '�z1SNSConnection.set_platform_application_attributesc C �" i }|dur
||d< | j d|d�S )a�
The `GetPlatformApplicationAttributes` action retrieves the
attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
For more information, see `Using Amazon SNS Mobile Push
Notifications`_.
:type platform_application_arn: string
:param platform_application_arn: PlatformApplicationArn for
GetPlatformApplicationAttributesInput.
Nr� � GetPlatformApplicationAttributesr� r; �r r� r/ r# r# r$ �#get_platform_application_attributes s �z1SNSConnection.get_platform_application_attributesc C r� )a�
The `ListPlatformApplications` action lists the platform
application objects for the supported push notification
services, such as APNS and GCM. The results for
`ListPlatformApplications` are paginated and return a limited
list of applications, up to 100. If additional records are
available after the first page results, then a NextToken
string will be returned. To receive the next page, you call
`ListPlatformApplications` using the NextToken string received
from the previous call. When there are no more records to
return, NextToken will be null. For more information, see
`Using Amazon SNS Mobile Push Notifications`_.
:type next_token: string
:param next_token: NextToken string is used when calling
ListPlatformApplications action to retrieve additional records that
are available after the first page results.
Nr9 �ListPlatformApplicationsr� r; r= r# r# r$ �list_platform_applications, s �z(SNSConnection.list_platform_applicationsc C s2 i }|dur
||d< |dur||d< | j d|d�S )a�
The `ListEndpointsByPlatformApplication` action lists the
endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS. The results
for `ListEndpointsByPlatformApplication` are paginated and
return a limited list of endpoints, up to 100. If additional
records are available after the first page results, then a
NextToken string will be returned. To receive the next page,
you call `ListEndpointsByPlatformApplication` again using the
NextToken string received from the previous call. When there
are no more records to return, NextToken will be null. For
more information, see `Using Amazon SNS Mobile Push
Notifications`_.
:type platform_application_arn: string
:param platform_application_arn: PlatformApplicationArn for
ListEndpointsByPlatformApplicationInput action.
:type next_token: string
:param next_token: NextToken string is used when calling
ListEndpointsByPlatformApplication action to retrieve additional
records that are available after the first page results.
Nr� r9 �"ListEndpointsByPlatformApplicationr� r; )r r� r> r/ r# r# r$ �&list_endpoints_by_platform_applicationF s �z4SNSConnection.list_endpoints_by_platform_applicationc C r� )a�
The `DeletePlatformApplication` action deletes a platform
application object for one of the supported push notification
services, such as APNS and GCM. For more information, see
`Using Amazon SNS Mobile Push Notifications`_.
:type platform_application_arn: string
:param platform_application_arn: PlatformApplicationArn of platform
application object to delete.
Nr� �DeletePlatformApplicationr� r; r� r# r# r$ �delete_platform_applicationi s �z)SNSConnection.delete_platform_applicationc C sX i }|dur
||d< |dur||d< |dur||d< |dur%| � ||d� | jd|d�S )am
The `CreatePlatformEndpoint` creates an endpoint for a device
and mobile app on one of the supported push notification
services, such as GCM and APNS. `CreatePlatformEndpoint`
requires the PlatformApplicationArn that is returned from
`CreatePlatformApplication`. The EndpointArn that is returned
when using `CreatePlatformEndpoint` can then be used by the
`Publish` action to send a message to a mobile app or by the
`Subscribe` action for subscription to a topic. For more
information, see `Using Amazon SNS Mobile Push
Notifications`_.
:type platform_application_arn: string
:param platform_application_arn: PlatformApplicationArn returned from
CreatePlatformApplication is used to create a an endpoint.
:type token: string
:param token: Unique identifier created by the notification service for
an app on a device. The specific name for Token will vary,
depending on which notification service is being used. For example,
when using APNS as the notification service, you need the device
token. Alternatively, when using GCM or ADM, the device token
equivalent is called the registration ID.
:type custom_user_data: string
:param custom_user_data: Arbitrary user data to associate with the
endpoint. SNS does not use this data. The data must be in UTF-8
format and less than 2KB.
:type attributes: map
:param attributes: For a list of attributes, see
`SetEndpointAttributes`_.
Nr� r� �CustomUserDatar� �CreatePlatformEndpointr� r� )r r� r� �custom_user_datar� r/ r# r# r$ �create_platform_endpoint{ s %�z&SNSConnection.create_platform_endpointc C r� )a
The `DeleteEndpoint` action, which is idempotent, deletes the
endpoint from SNS. For more information, see `Using Amazon SNS
Mobile Push Notifications`_.
:type endpoint_arn: string
:param endpoint_arn: EndpointArn of endpoint to delete.
N� EndpointArn�DeleteEndpointr� r; �r � endpoint_arnr/ r# r# r$ �delete_endpoint� s
z SNSConnection.delete_endpointc C r� )a!
The `SetEndpointAttributes` action sets the attributes for an
endpoint for a device on one of the supported push
notification services, such as GCM and APNS. For more
information, see `Using Amazon SNS Mobile Push
Notifications`_.
:type endpoint_arn: string
:param endpoint_arn: EndpointArn used for SetEndpointAttributes action.
:type attributes: map
:param attributes:
A map of the endpoint attributes. Attributes in this map include the
following:
+ `CustomUserData` -- arbitrary user data to associate with the
endpoint. SNS does not use this data. The data must be in UTF-8
format and less than 2KB.
+ `Enabled` -- flag that enables/disables delivery to the endpoint.
Message Processor will set this to false when a notification
service indicates to SNS that the endpoint is invalid. Users can
set it back to true, typically after updating Token.
+ `Token` -- device token, also referred to as a registration id, for
an app and mobile device. This is returned from the notification
service when an app and mobile device are registered with the
notification service.
Nr� r� �SetEndpointAttributesr� r� )r r� r� r/ r# r# r$ �set_endpoint_attributes� s �z%SNSConnection.set_endpoint_attributesc C r� )av
The `GetEndpointAttributes` retrieves the endpoint attributes
for a device on one of the supported push notification
services, such as GCM and APNS. For more information, see
`Using Amazon SNS Mobile Push Notifications`_.
:type endpoint_arn: string
:param endpoint_arn: EndpointArn for GetEndpointAttributes input.
Nr� �GetEndpointAttributesr� r; r� r# r# r$ �get_endpoint_attributes� s �z%SNSConnection.get_endpoint_attributesr\ c C s� d|d< | j ||||d�}|�� �d�}tj�|� |jdkr$t�|�S tj� d|j|j
f � tj� d| � | � |j|j
|��)N�JSON� ContentType)r� �verbr r/ ry �� z%s %sz%s) � make_request�read�decode�boto�logr �statusr r� �error�reason�
ResponseError)r r� r/ r r� �response�bodyr# r# r$ r< � s �
zSNSConnection._make_request)NNTNNNNNr NNr
NTN)N)NNNNNN)F)NNN)NN)NNNN)r
r\ )'�__name__�
__module__� __qualname__�__doc__r� �config�getr r �
APIVersionr r6 r7 r? rE rM rU rW rZ r] rs rx r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r< �
__classcell__r# r# r! r$ r sl
��
�L 5
�
�0
�0
�
�
#
�
1
&r )
�uuidr� �boto.connectionr �boto.regioninfor � boto.compatr r� r r# r# r# r$ �<module> s