SNSServiceResource#
Auto-generated documentation for SNS type annotations stubs module types-aiobotocore-sns.
SNSServiceResource#
Type annotations and code completion for session.resource("sns")
, included resources and collections.
boto3 documentation
# SNSServiceResource usage example
from types_aiobotocore_sns.service_resource import SNSServiceResource
def get_sns_resource() -> SNSServiceResource:
return session.resource("sns")
Attributes#
-
meta
: SNSResourceMeta -
platform_applications
: ServiceResourcePlatformApplicationsCollection -
subscriptions
: ServiceResourceSubscriptionsCollection -
topics
: ServiceResourceTopicsCollection
Collections#
ServiceResourcePlatformApplicationsCollection#
Provides access to PlatformApplication resource.
Type annotations and code completion for session.resource("sns").platform_applications
collection.
boto3 documentation
# ServiceResourcePlatformApplicationsCollection usage example
from types_aiobotocore_sns.service_resource import ServiceResourcePlatformApplicationsCollection
def get_collection() -> ServiceResourcePlatformApplicationsCollection:
return session.resource("sns").platform_applications
ServiceResourceSubscriptionsCollection#
Provides access to Subscription resource.
Type annotations and code completion for session.resource("sns").subscriptions
collection.
boto3 documentation
# ServiceResourceSubscriptionsCollection usage example
from types_aiobotocore_sns.service_resource import ServiceResourceSubscriptionsCollection
def get_collection() -> ServiceResourceSubscriptionsCollection:
return session.resource("sns").subscriptions
ServiceResourceTopicsCollection#
Provides access to Topic resource.
Type annotations and code completion for session.resource("sns").topics
collection.
boto3 documentation
# ServiceResourceTopicsCollection usage example
from types_aiobotocore_sns.service_resource import ServiceResourceTopicsCollection
def get_collection() -> ServiceResourceTopicsCollection:
return session.resource("sns").topics
Methods#
SNSServiceResource.PlatformApplication method#
Creates a PlatformApplication resource.
Type annotations and code completion for session.resource("sns").PlatformApplication
method.
boto3 documentation
# PlatformApplication method definition
await def PlatformApplication(
self,
arn: str,
) -> PlatformApplication:
...
SNSServiceResource.PlatformEndpoint method#
Creates a PlatformEndpoint resource.
Type annotations and code completion for session.resource("sns").PlatformEndpoint
method.
boto3 documentation
# PlatformEndpoint method definition
await def PlatformEndpoint(
self,
arn: str,
) -> PlatformEndpoint:
...
SNSServiceResource.Subscription method#
Creates a Subscription resource.
Type annotations and code completion for session.resource("sns").Subscription
method.
boto3 documentation
# Subscription method definition
await def Subscription(
self,
arn: str,
) -> Subscription:
...
SNSServiceResource.Topic method#
Creates a Topic resource.
Type annotations and code completion for session.resource("sns").Topic
method.
boto3 documentation
# Topic method definition
await def Topic(
self,
arn: str,
) -> Topic:
...
SNSServiceResource.create_platform_application method#
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register.
Type annotations and code completion for session.resource("sns").create_platform_application
method.
boto3 documentation
# create_platform_application method definition
await def create_platform_application(
self,
*,
Name: str,
Platform: str,
Attributes: Mapping[str, str],
) -> PlatformApplication:
...
# create_platform_application method usage example with argument unpacking
kwargs: CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef = { # (1)
"Name": ...,
"Platform": ...,
"Attributes": ...,
}
parent.create_platform_application(**kwargs)
SNSServiceResource.create_topic method#
Creates a topic to which notifications can be published.
Type annotations and code completion for session.resource("sns").create_topic
method.
boto3 documentation
# create_topic method definition
await def create_topic(
self,
*,
Name: str,
Attributes: Mapping[str, str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
DataProtectionPolicy: str = ...,
) -> Topic:
...
- See TagTypeDef
# create_topic method usage example with argument unpacking
kwargs: CreateTopicInputServiceResourceCreateTopicTypeDef = { # (1)
"Name": ...,
}
parent.create_topic(**kwargs)
SNSServiceResource.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for session.resource("sns").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
PlatformApplication#
Type annotations and code completion for session.resource("sns").PlatformApplication
class.
boto3 documentation
# PlatformApplication usage example
from types_aiobotocore_sns.service_resource import PlatformApplication
def get_resource() -> PlatformApplication:
return session.resource("sns").PlatformApplication(...)
PlatformApplication attributes#
attributes
:Awaitable
[Dict
[str
,str
]]arn
:str
endpoints
: PlatformApplicationEndpointsCollection
PlatformApplication collections#
PlatformApplication.endpoints#
Provides access to PlatformEndpoint resource.
Type annotations and code completion for session.resource("sns").PlatformApplication(...).endpoints
collection.
boto3 documentation
# PlatformApplicationEndpointsCollection usage example
from types_aiobotocore_sns.service_resource import PlatformApplicationEndpointsCollection
def get_collection() -> PlatformApplicationEndpointsCollection:
resource = session.resource("sns").PlatformApplication(...)
return resource.endpoints
PlatformApplication methods#
PlatformApplication.create_platform_endpoint method#
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
Type annotations and code completion for aiobotocore.resource("sns").create_platform_endpoint
method.
boto3 documentation
# create_platform_endpoint method definition
await def create_platform_endpoint(
self,
*,
Token: str,
CustomUserData: str = ...,
Attributes: Mapping[str, str] = ...,
) -> PlatformEndpoint:
...
# create_platform_endpoint method usage example with argument unpacking
kwargs: CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef = { # (1)
"Token": ...,
}
parent.create_platform_endpoint(**kwargs)
PlatformApplication.delete method#
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
Type annotations and code completion for aiobotocore.resource("sns").delete
method.
boto3 documentation
# delete method definition
await def delete(
self,
) -> None:
...
PlatformApplication.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("sns").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
PlatformApplication.load method#
Calls meth:SNS.Client.get_platform_application_attributes
to update the
attributes of the PlatformApplication resource.
Type annotations and code completion for aiobotocore.resource("sns").load
method.
boto3 documentation
# load method definition
await def load(
self,
) -> None:
...
PlatformApplication.reload method#
Calls meth:SNS.Client.get_platform_application_attributes
to update the
attributes of the PlatformApplication resource.
Type annotations and code completion for aiobotocore.resource("sns").reload
method.
boto3 documentation
# reload method definition
await def reload(
self,
) -> None:
...
PlatformApplication.set_attributes method#
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
Type annotations and code completion for aiobotocore.resource("sns").set_attributes
method.
boto3 documentation
# set_attributes method definition
await def set_attributes(
self,
*,
Attributes: Mapping[str, str],
) -> None:
...
# set_attributes method usage example with argument unpacking
kwargs: SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef = { # (1)
"Attributes": ...,
}
parent.set_attributes(**kwargs)
PlatformEndpoint#
Type annotations and code completion for session.resource("sns").PlatformEndpoint
class.
boto3 documentation
# PlatformEndpoint usage example
from types_aiobotocore_sns.service_resource import PlatformEndpoint
def get_resource() -> PlatformEndpoint:
return session.resource("sns").PlatformEndpoint(...)
PlatformEndpoint attributes#
attributes
:Awaitable
[Dict
[str
,str
]]arn
:str
PlatformEndpoint methods#
PlatformEndpoint.delete method#
Deletes the endpoint for a device and mobile app from Amazon SNS.
Type annotations and code completion for aiobotocore.resource("sns").delete
method.
boto3 documentation
# delete method definition
await def delete(
self,
) -> None:
...
PlatformEndpoint.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("sns").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
PlatformEndpoint.load method#
Calls meth:SNS.Client.get_endpoint_attributes
to update the attributes of
the PlatformEndpoint resource.
Type annotations and code completion for aiobotocore.resource("sns").load
method.
boto3 documentation
# load method definition
await def load(
self,
) -> None:
...
PlatformEndpoint.publish method#
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to
a phone number, or a message to a mobile platform endpoint (when you specify the
TargetArn
).
Type annotations and code completion for aiobotocore.resource("sns").publish
method.
boto3 documentation
# publish method definition
await def publish(
self,
*,
Message: str,
TopicArn: str = ...,
PhoneNumber: str = ...,
Subject: str = ...,
MessageStructure: str = ...,
MessageAttributes: Mapping[str, MessageAttributeValueTypeDef] = ..., # (1)
MessageDeduplicationId: str = ...,
MessageGroupId: str = ...,
) -> PublishResponseTypeDef: # (2)
...
# publish method usage example with argument unpacking
kwargs: PublishInputPlatformEndpointPublishTypeDef = { # (1)
"Message": ...,
}
parent.publish(**kwargs)
PlatformEndpoint.reload method#
Calls meth:SNS.Client.get_endpoint_attributes
to update the attributes of
the PlatformEndpoint resource.
Type annotations and code completion for aiobotocore.resource("sns").reload
method.
boto3 documentation
# reload method definition
await def reload(
self,
) -> None:
...
PlatformEndpoint.set_attributes method#
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
Type annotations and code completion for aiobotocore.resource("sns").set_attributes
method.
boto3 documentation
# set_attributes method definition
await def set_attributes(
self,
*,
Attributes: Mapping[str, str],
) -> None:
...
# set_attributes method usage example with argument unpacking
kwargs: SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef = { # (1)
"Attributes": ...,
}
parent.set_attributes(**kwargs)
Subscription#
Type annotations and code completion for session.resource("sns").Subscription
class.
boto3 documentation
# Subscription usage example
from types_aiobotocore_sns.service_resource import Subscription
def get_resource() -> Subscription:
return session.resource("sns").Subscription(...)
Subscription attributes#
attributes
:Awaitable
[Dict
[str
,str
]]arn
:str
Subscription methods#
Subscription.delete method#
Deletes a subscription.
Type annotations and code completion for aiobotocore.resource("sns").delete
method.
boto3 documentation
# delete method definition
await def delete(
self,
) -> None:
...
Subscription.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("sns").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
Subscription.load method#
Calls meth:SNS.Client.get_subscription_attributes
to update the attributes
of the Subscription resource.
Type annotations and code completion for aiobotocore.resource("sns").load
method.
boto3 documentation
# load method definition
await def load(
self,
) -> None:
...
Subscription.reload method#
Calls meth:SNS.Client.get_subscription_attributes
to update the attributes
of the Subscription resource.
Type annotations and code completion for aiobotocore.resource("sns").reload
method.
boto3 documentation
# reload method definition
await def reload(
self,
) -> None:
...
Subscription.set_attributes method#
Allows a subscription owner to set an attribute of the subscription to a new value.
Type annotations and code completion for aiobotocore.resource("sns").set_attributes
method.
boto3 documentation
# set_attributes method definition
await def set_attributes(
self,
*,
AttributeName: str,
AttributeValue: str = ...,
) -> None:
...
# set_attributes method usage example with argument unpacking
kwargs: SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef = { # (1)
"AttributeName": ...,
}
parent.set_attributes(**kwargs)
Topic#
Type annotations and code completion for session.resource("sns").Topic
class.
boto3 documentation
# Topic usage example
from types_aiobotocore_sns.service_resource import Topic
def get_resource() -> Topic:
return session.resource("sns").Topic(...)
Topic attributes#
attributes
:Awaitable
[Dict
[str
,str
]]arn
:str
subscriptions
: TopicSubscriptionsCollection
Topic collections#
Topic.subscriptions#
Provides access to Subscription resource.
Type annotations and code completion for session.resource("sns").Topic(...).subscriptions
collection.
boto3 documentation
# TopicSubscriptionsCollection usage example
from types_aiobotocore_sns.service_resource import TopicSubscriptionsCollection
def get_collection() -> TopicSubscriptionsCollection:
resource = session.resource("sns").Topic(...)
return resource.subscriptions
Topic methods#
Topic.add_permission method#
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
Type annotations and code completion for aiobotocore.resource("sns").add_permission
method.
boto3 documentation
# add_permission method definition
await def add_permission(
self,
*,
Label: str,
AWSAccountId: Sequence[str],
ActionName: Sequence[str],
) -> None:
...
# add_permission method usage example with argument unpacking
kwargs: AddPermissionInputTopicAddPermissionTypeDef = { # (1)
"Label": ...,
"AWSAccountId": ...,
"ActionName": ...,
}
parent.add_permission(**kwargs)
Topic.confirm_subscription method#
Verifies an endpoint owner's intent to receive messages by validating the token
sent to the endpoint by an earlier Subscribe
action.
Type annotations and code completion for aiobotocore.resource("sns").confirm_subscription
method.
boto3 documentation
# confirm_subscription method definition
await def confirm_subscription(
self,
*,
Token: str,
AuthenticateOnUnsubscribe: str = ...,
) -> Subscription:
...
# confirm_subscription method usage example with argument unpacking
kwargs: ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef = { # (1)
"Token": ...,
}
parent.confirm_subscription(**kwargs)
Topic.delete method#
Deletes a topic and all its subscriptions.
Type annotations and code completion for aiobotocore.resource("sns").delete
method.
boto3 documentation
# delete method definition
await def delete(
self,
) -> None:
...
Topic.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("sns").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
Topic.load method#
Calls meth:SNS.Client.get_topic_attributes
to update the attributes of the
Topic resource.
Type annotations and code completion for aiobotocore.resource("sns").load
method.
boto3 documentation
# load method definition
await def load(
self,
) -> None:
...
Topic.publish method#
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to
a phone number, or a message to a mobile platform endpoint (when you specify the
TargetArn
).
Type annotations and code completion for aiobotocore.resource("sns").publish
method.
boto3 documentation
# publish method definition
await def publish(
self,
*,
Message: str,
TargetArn: str = ...,
PhoneNumber: str = ...,
Subject: str = ...,
MessageStructure: str = ...,
MessageAttributes: Mapping[str, MessageAttributeValueTypeDef] = ..., # (1)
MessageDeduplicationId: str = ...,
MessageGroupId: str = ...,
) -> PublishResponseTypeDef: # (2)
...
# publish method usage example with argument unpacking
kwargs: PublishInputTopicPublishTypeDef = { # (1)
"Message": ...,
}
parent.publish(**kwargs)
Topic.reload method#
Calls meth:SNS.Client.get_topic_attributes
to update the attributes of the
Topic resource.
Type annotations and code completion for aiobotocore.resource("sns").reload
method.
boto3 documentation
# reload method definition
await def reload(
self,
) -> None:
...
Topic.remove_permission method#
Removes a statement from a topic's access control policy.
Type annotations and code completion for aiobotocore.resource("sns").remove_permission
method.
boto3 documentation
# remove_permission method definition
await def remove_permission(
self,
*,
Label: str,
) -> None:
...
# remove_permission method usage example with argument unpacking
kwargs: RemovePermissionInputTopicRemovePermissionTypeDef = { # (1)
"Label": ...,
}
parent.remove_permission(**kwargs)
Topic.set_attributes method#
Allows a topic owner to set an attribute of the topic to a new value.
Type annotations and code completion for aiobotocore.resource("sns").set_attributes
method.
boto3 documentation
# set_attributes method definition
await def set_attributes(
self,
*,
AttributeName: str,
AttributeValue: str = ...,
) -> None:
...
# set_attributes method usage example with argument unpacking
kwargs: SetTopicAttributesInputTopicSetAttributesTypeDef = { # (1)
"AttributeName": ...,
}
parent.set_attributes(**kwargs)
Topic.subscribe method#
Subscribes an endpoint to an Amazon SNS topic.
Type annotations and code completion for aiobotocore.resource("sns").subscribe
method.
boto3 documentation
# subscribe method definition
await def subscribe(
self,
*,
Protocol: str,
Endpoint: str = ...,
Attributes: Mapping[str, str] = ...,
ReturnSubscriptionArn: bool = ...,
) -> Subscription:
...
# subscribe method usage example with argument unpacking
kwargs: SubscribeInputTopicSubscribeTypeDef = { # (1)
"Protocol": ...,
}
parent.subscribe(**kwargs)