AWS.Tools.SimpleNotificationService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SimpleNotificationService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet"> <summary> Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.ActionName"> <summary> <para> <para>The action you want to allow for the specified principal(s).</para><para>Valid values: any Amazon SNS action name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.AWSAccountId"> <summary> <para> <para>The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.Label"> <summary> <para> <para>A unique identifier for the new policy statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic whose access control policy you wish to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.AddSNSResourceTagCmdlet"> <summary> Add tags to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the <i>Amazon SNS Developer Guide</i>. <para> When you use topic tags, keep the following guidelines in mind: </para><ul><li><para> Adding more than 50 tags to a topic isn't recommended. </para></li><li><para> Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings. </para></li><li><para> Tags are case-sensitive. </para></li><li><para> A new tag with a key identical to that of an existing tag overwrites the existing tag. </para></li><li><para> Tagging actions are limited to 10 TPS per AWS account. If your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>. </para></li></ul><para> For a full list of tag restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-limits.html#limits-topics">Limits Related to Topics</a> in the <i>Amazon SNS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the topic to which to add tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to be added to the specified topic. A tag consists of a required key and an optional value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.AuthenticateOnUnsubscribe"> <summary> <para> <para>Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.Token"> <summary> <para> <para>Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic for which you wish to confirm a subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet"> <summary> Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days. <para> This action is throttled at 100 transactions per second (TPS). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.Attribute"> <summary> <para> <para>A map of attributes with their corresponding values.</para><para>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</para><ul><li><para><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</para></li><li><para><code>RawMessageDelivery</code> – When set to <code>true</code>, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.Endpoint"> <summary> <para> <para>The endpoint that you want to receive notifications. Endpoints vary by protocol:</para><ul><li><para>For the <code>http</code> protocol, the endpoint is an URL beginning with "https://"</para></li><li><para>For the <code>https</code> protocol, the endpoint is a URL beginning with "https://"</para></li><li><para>For the <code>email</code> protocol, the endpoint is an email address</para></li><li><para>For the <code>email-json</code> protocol, the endpoint is an email address</para></li><li><para>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device</para></li><li><para>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue</para></li><li><para>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</para></li><li><para>For the <code>lambda</code> protocol, the endpoint is the ARN of an AWS Lambda function.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.Protocol"> <summary> <para> <para>The protocol you want to use. Supported protocols include:</para><ul><li><para><code>http</code> – delivery of JSON-encoded message via HTTP POST</para></li><li><para><code>https</code> – delivery of JSON-encoded message via HTTPS POST</para></li><li><para><code>email</code> – delivery of message via SMTP</para></li><li><para><code>email-json</code> – delivery of JSON-encoded message via SMTP</para></li><li><para><code>sms</code> – delivery of message via SMS</para></li><li><para><code>sqs</code> – delivery of JSON-encoded message to an Amazon SQS queue</para></li><li><para><code>application</code> – delivery of JSON-encoded message to an EndpointArn for a mobile app and device.</para></li><li><para><code>lambda</code> – delivery of JSON-encoded message to an AWS Lambda function.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.ReturnSubscriptionArn"> <summary> <para> <para>Sets whether the response from the <code>Subscribe</code> request includes the subscription ARN, even if the subscription is not yet confirmed.</para><para>If you set this parameter to <code>false</code>, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the <code>ConfirmSubscription</code> action with a confirmation token.</para><para>If you set this parameter to <code>true</code>, the response includes the ARN in all cases, even if the subscription is not yet confirmed.</para><para>The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic you want to subscribe to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet"> <summary> Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended. <para> This action is throttled at 100 transactions per second (TPS). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet.SubscriptionArn"> <summary> <para> <para>The ARN of the subscription to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet.PassThru"> <summary> Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.EnableSNSPhoneNumberCmdlet"> <summary> Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number. <para> You can opt in a phone number only once every 30 days. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.EnableSNSPhoneNumberCmdlet.PhoneNumber"> <summary> <para> <para>The phone number to opt in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.EnableSNSPhoneNumberCmdlet.PassThru"> <summary> Returns the value passed to the PhoneNumber parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.EnableSNSPhoneNumberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointAttributeCmdlet"> <summary> Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointAttributeCmdlet.EndpointArn"> <summary> <para> <para>EndpointArn for GetEndpointAttributes input.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet"> <summary> Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for <code>ListEndpointsByPlatformApplication</code> 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 <code>ListEndpointsByPlatformApplication</code> 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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. <para> This action is throttled at 30 transactions per second (TPS). </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.NextToken"> <summary> <para> <para>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSPhoneNumbersOptedOutCmdlet"> <summary> Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. <para> The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a <code>NextToken</code> string will be returned. To receive the next page, you call <code>ListPhoneNumbersOptedOut</code> again using the <code>NextToken</code> string received from the previous call. When there are no more records to return, <code>NextToken</code> will be null. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPhoneNumbersOptedOutCmdlet.NextToken"> <summary> <para> <para>A <code>NextToken</code> string is used when you call the <code>ListPhoneNumbersOptedOut</code> action to retrieve additional records that are available after the first page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationAttributeCmdlet"> <summary> Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationAttributeCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn for GetPlatformApplicationAttributesInput.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationListCmdlet"> <summary> Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> 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 <code>ListPlatformApplications</code> 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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. <para> This action is throttled at 15 transactions per second (TPS). </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationListCmdlet.NextToken"> <summary> <para> <para>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSResourceTagCmdlet"> <summary> List all tags added to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the <i>Amazon Simple Notification Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the topic for which to list tags.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSAttributeCmdlet"> <summary> Returns the settings for sending SMS messages from your account. <para> These settings are set with the <code>SetSMSAttributes</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSAttributeCmdlet.Attribute"> <summary> <para> <para>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for which you want values.</para><para>For all attribute names, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>.</para><para>If you don't use this parameter, Amazon SNS returns all SMS attributes.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionCmdlet"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. <para> This action is throttled at 30 transactions per second (TPS). </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <code>ListSubscriptions</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionAttributeCmdlet"> <summary> Returns all of the properties of a subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionAttributeCmdlet.SubscriptionArn"> <summary> <para> <para>The ARN of the subscription whose properties you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. <para> This action is throttled at 30 transactions per second (TPS). </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic for which you wish to find subscriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicCmdlet"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. <para> This action is throttled at 30 transactions per second (TPS). </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <code>ListTopics</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicAttributeCmdlet"> <summary> Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicAttributeCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic whose properties you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet"> <summary> Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the <code>CreatePlatformApplication</code> 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 WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key". <para> For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html">Getting Started with Apple Push Notification Service</a>, <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-adm.html">Getting Started with Amazon Device Messaging</a>, <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-baidu.html">Getting Started with Baidu Cloud Push</a>, <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html">Getting Started with Google Cloud Messaging for Android</a>, <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-mpns.html">Getting Started with MPNS</a>, or <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-wns.html">Getting Started with WNS</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Attribute"> <summary> <para> <para>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">SetPlatformApplicationAttributes</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Name"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Platform"> <summary> <para> <para>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet"> <summary> Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. <para> When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for Baidu</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.Attribute"> <summary> <para> <para>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">SetEndpointAttributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.CustomUserData"> <summary> <para> <para>Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.Token"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet"> <summary> Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see <a href="http://aws.amazon.com/sns/">https://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.Attribute"> <summary> <para> <para>A map of attributes with their corresponding values.</para><para>The following lists the names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</para><ul><li><para><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</para></li><li><para><code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</para></li></ul><para>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>:</para><ul><li><para><code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.Name"> <summary> <para> <para>The name of the topic you want to create.</para><para>Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.Tag"> <summary> <para> <para>The list of tags to add to a new topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet"> <summary> Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number. <para> If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint. </para><para> When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly. </para><para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. </para><para> For more information about formatting messages, see <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom Platform-Specific Payloads in Messages to Mobile Devices</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.Message"> <summary> <para> <para>The message you want to send.</para><important><para>The <code>Message</code> parameter is always a string. If you set <code>MessageStructure</code> to <code>json</code>, you must string-encode the <code>Message</code> parameter.</para></important><para>If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. </para><para>Constraints:</para><ul><li><para>With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).</para></li><li><para>For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.</para><para>If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.</para><para>The total size limit for a single SMS <code>Publish</code> action is 1,600 characters.</para></li></ul><para>JSON-specific constraints:</para><ul><li><para>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.</para></li><li><para>The values will be parsed (unescaped) before they are used in outgoing messages.</para></li><li><para>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</para></li><li><para>Values have a minimum length of 0 (the empty string, "", is allowed).</para></li><li><para>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</para></li><li><para>Non-string values will cause the key to be ignored.</para></li><li><para>Keys that do not correspond to supported transport protocols are ignored.</para></li><li><para>Duplicate keys are not allowed.</para></li><li><para>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.MessageAttribute"> <summary> <para> <para>Message attributes for Publish action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.MessageStructure"> <summary> <para> <para>Set <code>MessageStructure</code> to <code>json</code> if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: </para><ul><li><para>be a syntactically valid JSON object; and</para></li><li><para>contain at least a top-level JSON key of "default" with a value that is a string.</para></li></ul><para>You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").</para><para>For information about sending different messages for each protocol using the AWS Management Console, go to <a href="https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol">Create Different Messages for Each Protocol</a> in the <i>Amazon Simple Notification Service Getting Started Guide</i>. </para><para>Valid value: <code>json</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.PhoneNumber"> <summary> <para> <para>The phone number to which you want to deliver an SMS message. Use E.164 format.</para><para>If you don't specify a value for the <code>PhoneNumber</code> parameter, you must specify a value for the <code>TargetArn</code> or <code>TopicArn</code> parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.Subject"> <summary> <para> <para>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.</para><para>Constraints: 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.TargetArn"> <summary> <para> <para>If you don't specify a value for the <code>TargetArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TopicArn</code> parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.TopicArn"> <summary> <para> <para>The topic you want to publish to.</para><para>If you don't specify a value for the <code>TopicArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet"> <summary> Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. <para> When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.EndpointArn"> <summary> <para> <para>EndpointArn of endpoint to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.PassThru"> <summary> Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet"> <summary> Removes a statement from a topic's access control policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.Label"> <summary> <para> <para>The unique label of the statement you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic whose access control policy you wish to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet"> <summary> Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn of platform application object to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.PassThru"> <summary> Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSResourceTagCmdlet"> <summary> Remove tags from the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the <i>Amazon SNS Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the topic from which to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove from the specified topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributeCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributeCmdlet.Attribute"> <summary> <para> <para>A map of the endpoint attributes. Attributes in this map include the following:</para><ul><li><para><code>CustomUserData</code> – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</para></li><li><para><code>Enabled</code> – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.</para></li><li><para><code>Token</code> – 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.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributeCmdlet.EndpointArn"> <summary> <para> <para>EndpointArn used for SetEndpointAttributes action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributeCmdlet.PassThru"> <summary> Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet"> <summary> Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring attributes for message delivery status, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html">Using Amazon SNS Application Attributes for Message Delivery Status</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet.Attribute"> <summary> <para> <para>A map of the platform application attributes. Attributes in this map include the following:</para><ul><li><para><code>PlatformCredential</code> – 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".</para></li><li><para><code>PlatformPrincipal</code> – 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".</para></li><li><para><code>EventEndpointCreated</code> – Topic ARN to which EndpointCreated event notifications should be sent.</para></li><li><para><code>EventEndpointDeleted</code> – Topic ARN to which EndpointDeleted event notifications should be sent.</para></li><li><para><code>EventEndpointUpdated</code> – Topic ARN to which EndpointUpdate event notifications should be sent.</para></li><li><para><code>EventDeliveryFailure</code> – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</para></li><li><para><code>SuccessFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</para></li><li><para><code>FailureFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</para></li><li><para><code>SuccessFeedbackSampleRate</code> – Sample rate percentage (0-100) of successfully delivered messages.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn for SetPlatformApplicationAttributes action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet.PassThru"> <summary> Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.SetSNSSMSAttributeCmdlet"> <summary> Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports. <para> You can override some of these settings for a single message when you use the <code>Publish</code> action with the <code>MessageAttributes.entry.N</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Sending an SMS Message</a> in the <i>Amazon SNS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSMSAttributeCmdlet.Attribute"> <summary> <para> <para>The default settings for sending SMS messages from your account. You can set values for the following attribute names:</para><para><code>MonthlySpendLimit</code> – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.</para><important><para>Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.</para></important><para>By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns">SNS Limit Increase case</a>. For <b>New limit value</b>, enter your desired monthly spend limit. In the <b>Use Case Description</b> field, explain that you are requesting an SMS monthly spend limit increase.</para><para><code>DeliveryStatusIAMRole</code> – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.</para><para><code>DeliveryStatusSuccessSamplingRate</code> – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to <code>0</code>. To write logs for 10% of your successful deliveries, set it to <code>10</code>.</para><para><code>DefaultSenderID</code> – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.</para><para><code>DefaultSMSType</code> – The type of SMS message that you will send by default. You can assign the following values:</para><ul><li><para><code>Promotional</code> – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.</para></li><li><para><code>Transactional</code> – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.</para></li></ul><para><code>UsageReportS3Bucket</code> – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:</para><ul><li><para>Time that the message was published (in UTC)</para></li><li><para>Message ID</para></li><li><para>Destination phone number</para></li><li><para>Message type</para></li><li><para>Delivery status</para></li><li><para>Message price (in USD)</para></li><li><para>Part number (a message is split into multiple parts if it is too long for a single message)</para></li><li><para>Total number of parts</para></li></ul><para>To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the <code>s3:PutObject</code> and <code>s3:GetBucketLocation</code> actions.</para><para>For an example bucket policy and usage report, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the <i>Amazon SNS Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSMSAttributeCmdlet.PassThru"> <summary> Returns the value passed to the Attribute parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSMSAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet"> <summary> Allows a subscription owner to set an attribute of the subscription to a new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.AttributeName"> <summary> <para> <para>A map of attributes with their corresponding values.</para><para>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</para><ul><li><para><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</para></li><li><para><code>RawMessageDelivery</code> – When set to <code>true</code>, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.AttributeValue"> <summary> <para> <para>The new value for the attribute in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.SubscriptionArn"> <summary> <para> <para>The ARN of the subscription to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.PassThru"> <summary> Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet"> <summary> Allows a topic owner to set an attribute of the topic to a new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.AttributeName"> <summary> <para> <para>A map of attributes with their corresponding values.</para><para>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</para><ul><li><para><code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</para></li><li><para><code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</para></li></ul><para>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>:</para><ul><li><para><code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.AttributeValue"> <summary> <para> <para>The new value for the attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.TestSNSIfPhoneNumberIsOptedOutCmdlet"> <summary> Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out. <para> To resume sending messages, you can opt in the number by using the <code>OptInPhoneNumber</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.TestSNSIfPhoneNumberIsOptedOutCmdlet.PhoneNumber"> <summary> <para> <para>The phone number for which you want to check the opt out status.</para> </para> </summary> </member> </members> </doc> |