Typed dictionaries
Auto-generated documentation for SNS type annotations stubs module mypy-boto3-sns.
AddPermissionInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import AddPermissionInputRequestTypeDef
def get_value() -> AddPermissionInputRequestTypeDef:
return {
"TopicArn": ...,
"Label": ...,
"AWSAccountId": ...,
"ActionName": ...,
}
Definition
class AddPermissionInputRequestTypeDef(TypedDict):
TopicArn: str,
Label: str,
AWSAccountId: Sequence[str],
ActionName: Sequence[str],
AddPermissionInputTopicAddPermissionTypeDef
Usage Example
from mypy_boto3_sns.type_defs import AddPermissionInputTopicAddPermissionTypeDef
def get_value() -> AddPermissionInputTopicAddPermissionTypeDef:
return {
"Label": ...,
"AWSAccountId": ...,
"ActionName": ...,
}
Definition
class AddPermissionInputTopicAddPermissionTypeDef(TypedDict):
Label: str,
AWSAccountId: Sequence[str],
ActionName: Sequence[str],
BatchResultErrorEntryTypeDef
Usage Example
from mypy_boto3_sns.type_defs import BatchResultErrorEntryTypeDef
def get_value() -> BatchResultErrorEntryTypeDef:
return {
"Id": ...,
"Code": ...,
"SenderFault": ...,
}
Definition
class BatchResultErrorEntryTypeDef(TypedDict):
Id: str,
Code: str,
SenderFault: bool,
Message: NotRequired[str],
CheckIfPhoneNumberIsOptedOutInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CheckIfPhoneNumberIsOptedOutInputRequestTypeDef
def get_value() -> CheckIfPhoneNumberIsOptedOutInputRequestTypeDef:
return {
"phoneNumber": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ConfirmSubscriptionInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ConfirmSubscriptionInputRequestTypeDef
def get_value() -> ConfirmSubscriptionInputRequestTypeDef:
return {
"TopicArn": ...,
"Token": ...,
}
Definition
class ConfirmSubscriptionInputRequestTypeDef(TypedDict):
TopicArn: str,
Token: str,
AuthenticateOnUnsubscribe: NotRequired[str],
ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef
def get_value() -> ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef:
return {
"Token": ...,
}
Definition
class ConfirmSubscriptionInputTopicConfirmSubscriptionTypeDef(TypedDict):
Token: str,
AuthenticateOnUnsubscribe: NotRequired[str],
CreatePlatformApplicationInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreatePlatformApplicationInputRequestTypeDef
def get_value() -> CreatePlatformApplicationInputRequestTypeDef:
return {
"Name": ...,
"Platform": ...,
"Attributes": ...,
}
Definition
class CreatePlatformApplicationInputRequestTypeDef(TypedDict):
Name: str,
Platform: str,
Attributes: Mapping[str, str],
CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef
def get_value() -> CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef:
return {
"Name": ...,
"Platform": ...,
"Attributes": ...,
}
Definition
class CreatePlatformApplicationInputServiceResourceCreatePlatformApplicationTypeDef(TypedDict):
Name: str,
Platform: str,
Attributes: Mapping[str, str],
CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef
def get_value() -> CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef:
return {
"Token": ...,
}
Definition
class CreatePlatformEndpointInputPlatformApplicationCreatePlatformEndpointTypeDef(TypedDict):
Token: str,
CustomUserData: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
CreatePlatformEndpointInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreatePlatformEndpointInputRequestTypeDef
def get_value() -> CreatePlatformEndpointInputRequestTypeDef:
return {
"PlatformApplicationArn": ...,
"Token": ...,
}
Definition
class CreatePlatformEndpointInputRequestTypeDef(TypedDict):
PlatformApplicationArn: str,
Token: str,
CustomUserData: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
CreateSMSSandboxPhoneNumberInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreateSMSSandboxPhoneNumberInputRequestTypeDef
def get_value() -> CreateSMSSandboxPhoneNumberInputRequestTypeDef:
return {
"PhoneNumber": ...,
}
Definition
class CreateSMSSandboxPhoneNumberInputRequestTypeDef(TypedDict):
PhoneNumber: str,
LanguageCode: NotRequired[LanguageCodeStringType], # (1)
TagTypeDef
Usage Example
from mypy_boto3_sns.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
DeleteEndpointInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import DeleteEndpointInputRequestTypeDef
def get_value() -> DeleteEndpointInputRequestTypeDef:
return {
"EndpointArn": ...,
}
DeletePlatformApplicationInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import DeletePlatformApplicationInputRequestTypeDef
def get_value() -> DeletePlatformApplicationInputRequestTypeDef:
return {
"PlatformApplicationArn": ...,
}
Definition
class DeletePlatformApplicationInputRequestTypeDef(TypedDict):
PlatformApplicationArn: str,
DeleteSMSSandboxPhoneNumberInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import DeleteSMSSandboxPhoneNumberInputRequestTypeDef
def get_value() -> DeleteSMSSandboxPhoneNumberInputRequestTypeDef:
return {
"PhoneNumber": ...,
}
DeleteTopicInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import DeleteTopicInputRequestTypeDef
def get_value() -> DeleteTopicInputRequestTypeDef:
return {
"TopicArn": ...,
}
EndpointTypeDef
Usage Example
from mypy_boto3_sns.type_defs import EndpointTypeDef
def get_value() -> EndpointTypeDef:
return {
"EndpointArn": ...,
}
Definition
class EndpointTypeDef(TypedDict):
EndpointArn: NotRequired[str],
Attributes: NotRequired[Dict[str, str]],
GetDataProtectionPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetDataProtectionPolicyInputRequestTypeDef
def get_value() -> GetDataProtectionPolicyInputRequestTypeDef:
return {
"ResourceArn": ...,
}
GetEndpointAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetEndpointAttributesInputRequestTypeDef
def get_value() -> GetEndpointAttributesInputRequestTypeDef:
return {
"EndpointArn": ...,
}
GetPlatformApplicationAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetPlatformApplicationAttributesInputRequestTypeDef
def get_value() -> GetPlatformApplicationAttributesInputRequestTypeDef:
return {
"PlatformApplicationArn": ...,
}
Definition
class GetPlatformApplicationAttributesInputRequestTypeDef(TypedDict):
PlatformApplicationArn: str,
GetSMSAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetSMSAttributesInputRequestTypeDef
def get_value() -> GetSMSAttributesInputRequestTypeDef:
return {
"attributes": ...,
}
Definition
class GetSMSAttributesInputRequestTypeDef(TypedDict):
attributes: NotRequired[Sequence[str]],
GetSubscriptionAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetSubscriptionAttributesInputRequestTypeDef
def get_value() -> GetSubscriptionAttributesInputRequestTypeDef:
return {
"SubscriptionArn": ...,
}
GetTopicAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetTopicAttributesInputRequestTypeDef
def get_value() -> GetTopicAttributesInputRequestTypeDef:
return {
"TopicArn": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListEndpointsByPlatformApplicationInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListEndpointsByPlatformApplicationInputRequestTypeDef
def get_value() -> ListEndpointsByPlatformApplicationInputRequestTypeDef:
return {
"PlatformApplicationArn": ...,
}
Definition
class ListEndpointsByPlatformApplicationInputRequestTypeDef(TypedDict):
PlatformApplicationArn: str,
NextToken: NotRequired[str],
ListOriginationNumbersRequestRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListOriginationNumbersRequestRequestTypeDef
def get_value() -> ListOriginationNumbersRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListOriginationNumbersRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PhoneNumberInformationTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PhoneNumberInformationTypeDef
def get_value() -> PhoneNumberInformationTypeDef:
return {
"CreatedAt": ...,
}
Definition
class PhoneNumberInformationTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
PhoneNumber: NotRequired[str],
Status: NotRequired[str],
Iso2CountryCode: NotRequired[str],
RouteType: NotRequired[RouteTypeType], # (1)
NumberCapabilities: NotRequired[List[NumberCapabilityType]], # (2)
- See RouteTypeType
- See NumberCapabilityType
ListPhoneNumbersOptedOutInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListPhoneNumbersOptedOutInputRequestTypeDef
def get_value() -> ListPhoneNumbersOptedOutInputRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListPhoneNumbersOptedOutInputRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
ListPlatformApplicationsInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListPlatformApplicationsInputRequestTypeDef
def get_value() -> ListPlatformApplicationsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListPlatformApplicationsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
PlatformApplicationTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PlatformApplicationTypeDef
def get_value() -> PlatformApplicationTypeDef:
return {
"PlatformApplicationArn": ...,
}
Definition
class PlatformApplicationTypeDef(TypedDict):
PlatformApplicationArn: NotRequired[str],
Attributes: NotRequired[Dict[str, str]],
ListSMSSandboxPhoneNumbersInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSMSSandboxPhoneNumbersInputRequestTypeDef
def get_value() -> ListSMSSandboxPhoneNumbersInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListSMSSandboxPhoneNumbersInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SMSSandboxPhoneNumberTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SMSSandboxPhoneNumberTypeDef
def get_value() -> SMSSandboxPhoneNumberTypeDef:
return {
"PhoneNumber": ...,
}
Definition
class SMSSandboxPhoneNumberTypeDef(TypedDict):
PhoneNumber: NotRequired[str],
Status: NotRequired[SMSSandboxPhoneNumberVerificationStatusType], # (1)
ListSubscriptionsByTopicInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSubscriptionsByTopicInputRequestTypeDef
def get_value() -> ListSubscriptionsByTopicInputRequestTypeDef:
return {
"TopicArn": ...,
}
Definition
class ListSubscriptionsByTopicInputRequestTypeDef(TypedDict):
TopicArn: str,
NextToken: NotRequired[str],
SubscriptionTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SubscriptionTypeDef
def get_value() -> SubscriptionTypeDef:
return {
"SubscriptionArn": ...,
}
Definition
class SubscriptionTypeDef(TypedDict):
SubscriptionArn: NotRequired[str],
Owner: NotRequired[str],
Protocol: NotRequired[str],
Endpoint: NotRequired[str],
TopicArn: NotRequired[str],
ListSubscriptionsInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSubscriptionsInputRequestTypeDef
def get_value() -> ListSubscriptionsInputRequestTypeDef:
return {
"NextToken": ...,
}
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
ListTopicsInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListTopicsInputRequestTypeDef
def get_value() -> ListTopicsInputRequestTypeDef:
return {
"NextToken": ...,
}
TopicTypeDef
Usage Example
from mypy_boto3_sns.type_defs import TopicTypeDef
def get_value() -> TopicTypeDef:
return {
"TopicArn": ...,
}
MessageAttributeValueTypeDef
Usage Example
from mypy_boto3_sns.type_defs import MessageAttributeValueTypeDef
def get_value() -> MessageAttributeValueTypeDef:
return {
"DataType": ...,
}
Definition
class MessageAttributeValueTypeDef(TypedDict):
DataType: str,
StringValue: NotRequired[str],
BinaryValue: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
OptInPhoneNumberInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import OptInPhoneNumberInputRequestTypeDef
def get_value() -> OptInPhoneNumberInputRequestTypeDef:
return {
"phoneNumber": ...,
}
PublishBatchResultEntryTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishBatchResultEntryTypeDef
def get_value() -> PublishBatchResultEntryTypeDef:
return {
"Id": ...,
}
Definition
class PublishBatchResultEntryTypeDef(TypedDict):
Id: NotRequired[str],
MessageId: NotRequired[str],
SequenceNumber: NotRequired[str],
PutDataProtectionPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PutDataProtectionPolicyInputRequestTypeDef
def get_value() -> PutDataProtectionPolicyInputRequestTypeDef:
return {
"ResourceArn": ...,
"DataProtectionPolicy": ...,
}
Definition
class PutDataProtectionPolicyInputRequestTypeDef(TypedDict):
ResourceArn: str,
DataProtectionPolicy: str,
RemovePermissionInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import RemovePermissionInputRequestTypeDef
def get_value() -> RemovePermissionInputRequestTypeDef:
return {
"TopicArn": ...,
"Label": ...,
}
RemovePermissionInputTopicRemovePermissionTypeDef
Usage Example
from mypy_boto3_sns.type_defs import RemovePermissionInputTopicRemovePermissionTypeDef
def get_value() -> RemovePermissionInputTopicRemovePermissionTypeDef:
return {
"Label": ...,
}
ServiceResourcePlatformApplicationRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ServiceResourcePlatformApplicationRequestTypeDef
def get_value() -> ServiceResourcePlatformApplicationRequestTypeDef:
return {
"arn": ...,
}
ServiceResourcePlatformEndpointRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ServiceResourcePlatformEndpointRequestTypeDef
def get_value() -> ServiceResourcePlatformEndpointRequestTypeDef:
return {
"arn": ...,
}
ServiceResourceSubscriptionRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ServiceResourceSubscriptionRequestTypeDef
def get_value() -> ServiceResourceSubscriptionRequestTypeDef:
return {
"arn": ...,
}
ServiceResourceTopicRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ServiceResourceTopicRequestTypeDef
def get_value() -> ServiceResourceTopicRequestTypeDef:
return {
"arn": ...,
}
SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef
def get_value() -> SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef:
return {
"Attributes": ...,
}
Definition
class SetEndpointAttributesInputPlatformEndpointSetAttributesTypeDef(TypedDict):
Attributes: Mapping[str, str],
SetEndpointAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetEndpointAttributesInputRequestTypeDef
def get_value() -> SetEndpointAttributesInputRequestTypeDef:
return {
"EndpointArn": ...,
"Attributes": ...,
}
Definition
class SetEndpointAttributesInputRequestTypeDef(TypedDict):
EndpointArn: str,
Attributes: Mapping[str, str],
SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef
def get_value() -> SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef:
return {
"Attributes": ...,
}
Definition
class SetPlatformApplicationAttributesInputPlatformApplicationSetAttributesTypeDef(TypedDict):
Attributes: Mapping[str, str],
SetPlatformApplicationAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetPlatformApplicationAttributesInputRequestTypeDef
def get_value() -> SetPlatformApplicationAttributesInputRequestTypeDef:
return {
"PlatformApplicationArn": ...,
"Attributes": ...,
}
Definition
class SetPlatformApplicationAttributesInputRequestTypeDef(TypedDict):
PlatformApplicationArn: str,
Attributes: Mapping[str, str],
SetSMSAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetSMSAttributesInputRequestTypeDef
def get_value() -> SetSMSAttributesInputRequestTypeDef:
return {
"attributes": ...,
}
SetSubscriptionAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetSubscriptionAttributesInputRequestTypeDef
def get_value() -> SetSubscriptionAttributesInputRequestTypeDef:
return {
"SubscriptionArn": ...,
"AttributeName": ...,
}
Definition
class SetSubscriptionAttributesInputRequestTypeDef(TypedDict):
SubscriptionArn: str,
AttributeName: str,
AttributeValue: NotRequired[str],
SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef
def get_value() -> SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef:
return {
"AttributeName": ...,
}
Definition
class SetSubscriptionAttributesInputSubscriptionSetAttributesTypeDef(TypedDict):
AttributeName: str,
AttributeValue: NotRequired[str],
SetTopicAttributesInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetTopicAttributesInputRequestTypeDef
def get_value() -> SetTopicAttributesInputRequestTypeDef:
return {
"TopicArn": ...,
"AttributeName": ...,
}
Definition
class SetTopicAttributesInputRequestTypeDef(TypedDict):
TopicArn: str,
AttributeName: str,
AttributeValue: NotRequired[str],
SetTopicAttributesInputTopicSetAttributesTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SetTopicAttributesInputTopicSetAttributesTypeDef
def get_value() -> SetTopicAttributesInputTopicSetAttributesTypeDef:
return {
"AttributeName": ...,
}
Definition
class SetTopicAttributesInputTopicSetAttributesTypeDef(TypedDict):
AttributeName: str,
AttributeValue: NotRequired[str],
SubscribeInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SubscribeInputRequestTypeDef
def get_value() -> SubscribeInputRequestTypeDef:
return {
"TopicArn": ...,
"Protocol": ...,
}
Definition
class SubscribeInputRequestTypeDef(TypedDict):
TopicArn: str,
Protocol: str,
Endpoint: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
ReturnSubscriptionArn: NotRequired[bool],
SubscribeInputTopicSubscribeTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SubscribeInputTopicSubscribeTypeDef
def get_value() -> SubscribeInputTopicSubscribeTypeDef:
return {
"Protocol": ...,
}
Definition
class SubscribeInputTopicSubscribeTypeDef(TypedDict):
Protocol: str,
Endpoint: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
ReturnSubscriptionArn: NotRequired[bool],
UnsubscribeInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import UnsubscribeInputRequestTypeDef
def get_value() -> UnsubscribeInputRequestTypeDef:
return {
"SubscriptionArn": ...,
}
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
VerifySMSSandboxPhoneNumberInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import VerifySMSSandboxPhoneNumberInputRequestTypeDef
def get_value() -> VerifySMSSandboxPhoneNumberInputRequestTypeDef:
return {
"PhoneNumber": ...,
"OneTimePassword": ...,
}
Definition
class VerifySMSSandboxPhoneNumberInputRequestTypeDef(TypedDict):
PhoneNumber: str,
OneTimePassword: str,
CheckIfPhoneNumberIsOptedOutResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CheckIfPhoneNumberIsOptedOutResponseTypeDef
def get_value() -> CheckIfPhoneNumberIsOptedOutResponseTypeDef:
return {
"isOptedOut": ...,
"ResponseMetadata": ...,
}
Definition
class CheckIfPhoneNumberIsOptedOutResponseTypeDef(TypedDict):
isOptedOut: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ConfirmSubscriptionResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ConfirmSubscriptionResponseTypeDef
def get_value() -> ConfirmSubscriptionResponseTypeDef:
return {
"SubscriptionArn": ...,
"ResponseMetadata": ...,
}
Definition
class ConfirmSubscriptionResponseTypeDef(TypedDict):
SubscriptionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateEndpointResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreateEndpointResponseTypeDef
def get_value() -> CreateEndpointResponseTypeDef:
return {
"EndpointArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateEndpointResponseTypeDef(TypedDict):
EndpointArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePlatformApplicationResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreatePlatformApplicationResponseTypeDef
def get_value() -> CreatePlatformApplicationResponseTypeDef:
return {
"PlatformApplicationArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePlatformApplicationResponseTypeDef(TypedDict):
PlatformApplicationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTopicResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreateTopicResponseTypeDef
def get_value() -> CreateTopicResponseTypeDef:
return {
"TopicArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateTopicResponseTypeDef(TypedDict):
TopicArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_sns.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDataProtectionPolicyResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetDataProtectionPolicyResponseTypeDef
def get_value() -> GetDataProtectionPolicyResponseTypeDef:
return {
"DataProtectionPolicy": ...,
"ResponseMetadata": ...,
}
Definition
class GetDataProtectionPolicyResponseTypeDef(TypedDict):
DataProtectionPolicy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetEndpointAttributesResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetEndpointAttributesResponseTypeDef
def get_value() -> GetEndpointAttributesResponseTypeDef:
return {
"Attributes": ...,
"ResponseMetadata": ...,
}
Definition
class GetEndpointAttributesResponseTypeDef(TypedDict):
Attributes: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetPlatformApplicationAttributesResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetPlatformApplicationAttributesResponseTypeDef
def get_value() -> GetPlatformApplicationAttributesResponseTypeDef:
return {
"Attributes": ...,
"ResponseMetadata": ...,
}
Definition
class GetPlatformApplicationAttributesResponseTypeDef(TypedDict):
Attributes: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSMSAttributesResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetSMSAttributesResponseTypeDef
def get_value() -> GetSMSAttributesResponseTypeDef:
return {
"attributes": ...,
"ResponseMetadata": ...,
}
Definition
class GetSMSAttributesResponseTypeDef(TypedDict):
attributes: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSMSSandboxAccountStatusResultTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetSMSSandboxAccountStatusResultTypeDef
def get_value() -> GetSMSSandboxAccountStatusResultTypeDef:
return {
"IsInSandbox": ...,
"ResponseMetadata": ...,
}
Definition
class GetSMSSandboxAccountStatusResultTypeDef(TypedDict):
IsInSandbox: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSubscriptionAttributesResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetSubscriptionAttributesResponseTypeDef
def get_value() -> GetSubscriptionAttributesResponseTypeDef:
return {
"Attributes": ...,
"ResponseMetadata": ...,
}
Definition
class GetSubscriptionAttributesResponseTypeDef(TypedDict):
Attributes: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTopicAttributesResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import GetTopicAttributesResponseTypeDef
def get_value() -> GetTopicAttributesResponseTypeDef:
return {
"Attributes": ...,
"ResponseMetadata": ...,
}
Definition
class GetTopicAttributesResponseTypeDef(TypedDict):
Attributes: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListPhoneNumbersOptedOutResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListPhoneNumbersOptedOutResponseTypeDef
def get_value() -> ListPhoneNumbersOptedOutResponseTypeDef:
return {
"phoneNumbers": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListPhoneNumbersOptedOutResponseTypeDef(TypedDict):
phoneNumbers: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PublishResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishResponseTypeDef
def get_value() -> PublishResponseTypeDef:
return {
"MessageId": ...,
"SequenceNumber": ...,
"ResponseMetadata": ...,
}
Definition
class PublishResponseTypeDef(TypedDict):
MessageId: str,
SequenceNumber: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SubscribeResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import SubscribeResponseTypeDef
def get_value() -> SubscribeResponseTypeDef:
return {
"SubscriptionArn": ...,
"ResponseMetadata": ...,
}
Definition
class SubscribeResponseTypeDef(TypedDict):
SubscriptionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTopicInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreateTopicInputRequestTypeDef
def get_value() -> CreateTopicInputRequestTypeDef:
return {
"Name": ...,
}
Definition
class CreateTopicInputRequestTypeDef(TypedDict):
Name: str,
Attributes: NotRequired[Mapping[str, str]],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
DataProtectionPolicy: NotRequired[str],
- See TagTypeDef
CreateTopicInputServiceResourceCreateTopicTypeDef
Usage Example
from mypy_boto3_sns.type_defs import CreateTopicInputServiceResourceCreateTopicTypeDef
def get_value() -> CreateTopicInputServiceResourceCreateTopicTypeDef:
return {
"Name": ...,
}
Definition
class CreateTopicInputServiceResourceCreateTopicTypeDef(TypedDict):
Name: str,
Attributes: NotRequired[Mapping[str, str]],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
DataProtectionPolicy: NotRequired[str],
- See TagTypeDef
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ListEndpointsByPlatformApplicationResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListEndpointsByPlatformApplicationResponseTypeDef
def get_value() -> ListEndpointsByPlatformApplicationResponseTypeDef:
return {
"Endpoints": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListEndpointsByPlatformApplicationResponseTypeDef(TypedDict):
Endpoints: List[EndpointTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEndpointsByPlatformApplicationInputListEndpointsByPlatformApplicationPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListEndpointsByPlatformApplicationInputListEndpointsByPlatformApplicationPaginateTypeDef
def get_value() -> ListEndpointsByPlatformApplicationInputListEndpointsByPlatformApplicationPaginateTypeDef:
return {
"PlatformApplicationArn": ...,
}
Definition
class ListEndpointsByPlatformApplicationInputListEndpointsByPlatformApplicationPaginateTypeDef(TypedDict):
PlatformApplicationArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListOriginationNumbersRequestListOriginationNumbersPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListOriginationNumbersRequestListOriginationNumbersPaginateTypeDef
def get_value() -> ListOriginationNumbersRequestListOriginationNumbersPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListOriginationNumbersRequestListOriginationNumbersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPhoneNumbersOptedOutInputListPhoneNumbersOptedOutPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListPhoneNumbersOptedOutInputListPhoneNumbersOptedOutPaginateTypeDef
def get_value() -> ListPhoneNumbersOptedOutInputListPhoneNumbersOptedOutPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListPhoneNumbersOptedOutInputListPhoneNumbersOptedOutPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPlatformApplicationsInputListPlatformApplicationsPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListPlatformApplicationsInputListPlatformApplicationsPaginateTypeDef
def get_value() -> ListPlatformApplicationsInputListPlatformApplicationsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListPlatformApplicationsInputListPlatformApplicationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSMSSandboxPhoneNumbersInputListSMSSandboxPhoneNumbersPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSMSSandboxPhoneNumbersInputListSMSSandboxPhoneNumbersPaginateTypeDef
def get_value() -> ListSMSSandboxPhoneNumbersInputListSMSSandboxPhoneNumbersPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListSMSSandboxPhoneNumbersInputListSMSSandboxPhoneNumbersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSubscriptionsByTopicInputListSubscriptionsByTopicPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSubscriptionsByTopicInputListSubscriptionsByTopicPaginateTypeDef
def get_value() -> ListSubscriptionsByTopicInputListSubscriptionsByTopicPaginateTypeDef:
return {
"TopicArn": ...,
}
Definition
class ListSubscriptionsByTopicInputListSubscriptionsByTopicPaginateTypeDef(TypedDict):
TopicArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSubscriptionsInputListSubscriptionsPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSubscriptionsInputListSubscriptionsPaginateTypeDef
def get_value() -> ListSubscriptionsInputListSubscriptionsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListSubscriptionsInputListSubscriptionsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTopicsInputListTopicsPaginateTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListTopicsInputListTopicsPaginateTypeDef
def get_value() -> ListTopicsInputListTopicsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListTopicsInputListTopicsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListOriginationNumbersResultTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListOriginationNumbersResultTypeDef
def get_value() -> ListOriginationNumbersResultTypeDef:
return {
"NextToken": ...,
"PhoneNumbers": ...,
"ResponseMetadata": ...,
}
Definition
class ListOriginationNumbersResultTypeDef(TypedDict):
NextToken: str,
PhoneNumbers: List[PhoneNumberInformationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPlatformApplicationsResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListPlatformApplicationsResponseTypeDef
def get_value() -> ListPlatformApplicationsResponseTypeDef:
return {
"PlatformApplications": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListPlatformApplicationsResponseTypeDef(TypedDict):
PlatformApplications: List[PlatformApplicationTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSMSSandboxPhoneNumbersResultTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSMSSandboxPhoneNumbersResultTypeDef
def get_value() -> ListSMSSandboxPhoneNumbersResultTypeDef:
return {
"PhoneNumbers": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSMSSandboxPhoneNumbersResultTypeDef(TypedDict):
PhoneNumbers: List[SMSSandboxPhoneNumberTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSubscriptionsByTopicResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSubscriptionsByTopicResponseTypeDef
def get_value() -> ListSubscriptionsByTopicResponseTypeDef:
return {
"Subscriptions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSubscriptionsByTopicResponseTypeDef(TypedDict):
Subscriptions: List[SubscriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSubscriptionsResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListSubscriptionsResponseTypeDef
def get_value() -> ListSubscriptionsResponseTypeDef:
return {
"Subscriptions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSubscriptionsResponseTypeDef(TypedDict):
Subscriptions: List[SubscriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTopicsResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import ListTopicsResponseTypeDef
def get_value() -> ListTopicsResponseTypeDef:
return {
"Topics": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTopicsResponseTypeDef(TypedDict):
Topics: List[TopicTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TopicTypeDef
- See ResponseMetadataTypeDef
PublishBatchRequestEntryTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishBatchRequestEntryTypeDef
def get_value() -> PublishBatchRequestEntryTypeDef:
return {
"Id": ...,
"Message": ...,
}
Definition
class PublishBatchRequestEntryTypeDef(TypedDict):
Id: str,
Message: str,
Subject: NotRequired[str],
MessageStructure: NotRequired[str],
MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]], # (1)
MessageDeduplicationId: NotRequired[str],
MessageGroupId: NotRequired[str],
PublishInputPlatformEndpointPublishTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishInputPlatformEndpointPublishTypeDef
def get_value() -> PublishInputPlatformEndpointPublishTypeDef:
return {
"Message": ...,
}
Definition
class PublishInputPlatformEndpointPublishTypeDef(TypedDict):
Message: str,
TopicArn: NotRequired[str],
PhoneNumber: NotRequired[str],
Subject: NotRequired[str],
MessageStructure: NotRequired[str],
MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]], # (1)
MessageDeduplicationId: NotRequired[str],
MessageGroupId: NotRequired[str],
PublishInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishInputRequestTypeDef
def get_value() -> PublishInputRequestTypeDef:
return {
"Message": ...,
}
Definition
class PublishInputRequestTypeDef(TypedDict):
Message: str,
TopicArn: NotRequired[str],
TargetArn: NotRequired[str],
PhoneNumber: NotRequired[str],
Subject: NotRequired[str],
MessageStructure: NotRequired[str],
MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]], # (1)
MessageDeduplicationId: NotRequired[str],
MessageGroupId: NotRequired[str],
PublishInputTopicPublishTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishInputTopicPublishTypeDef
def get_value() -> PublishInputTopicPublishTypeDef:
return {
"Message": ...,
}
Definition
class PublishInputTopicPublishTypeDef(TypedDict):
Message: str,
TargetArn: NotRequired[str],
PhoneNumber: NotRequired[str],
Subject: NotRequired[str],
MessageStructure: NotRequired[str],
MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]], # (1)
MessageDeduplicationId: NotRequired[str],
MessageGroupId: NotRequired[str],
PublishBatchResponseTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishBatchResponseTypeDef
def get_value() -> PublishBatchResponseTypeDef:
return {
"Successful": ...,
"Failed": ...,
"ResponseMetadata": ...,
}
Definition
class PublishBatchResponseTypeDef(TypedDict):
Successful: List[PublishBatchResultEntryTypeDef], # (1)
Failed: List[BatchResultErrorEntryTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PublishBatchInputRequestTypeDef
Usage Example
from mypy_boto3_sns.type_defs import PublishBatchInputRequestTypeDef
def get_value() -> PublishBatchInputRequestTypeDef:
return {
"TopicArn": ...,
"PublishBatchRequestEntries": ...,
}