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 Amazon Web Services accounts to the specified actions. <note><para> To remove the ability to change topic permissions, you must deny permissions to the <c>AddPermission</c>, <c>RemovePermission</c>, and <c>SetTopicAttributes</c> actions in your IAM policy. </para></note> </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, for example <c>Publish</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.AWSAccountId"> <summary> <para> <para>The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.AddPermissionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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 Amazon Web Services account, per Amazon Web Services Region. 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> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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.ConfirmSNSSMSSandboxPhoneNumberCmdlet"> <summary> Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account. <para> When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSMSSandboxPhoneNumberCmdlet.OneTimePassword"> <summary> <para> <para>The OTP sent to the destination number from the <c>CreateSMSSandBoxPhoneNumber</c> call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSMSSandboxPhoneNumberCmdlet.PhoneNumber"> <summary> <para> <para>The destination phone number to verify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSMSSandboxPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.VerifySMSSandboxPhoneNumberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSMSSandboxPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumber parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumber' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSMSSandboxPhoneNumberCmdlet.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 <c>Subscribe</c> 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 <c>AuthenticateOnUnsubscribe</c> 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 <c>true</c> and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services 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 <c>Subscribe</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SubscriptionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ConfirmSubscriptionResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ConfirmSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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> Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the <c>ConfirmSubscription</c> action to confirm the subscription. <para> You call the <c>ConfirmSubscription</c> action with the token from the subscription response. Confirmation tokens are valid for two days. </para><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 <c>Subscribe</c> action uses:</para><ul><li><para><c>DeliveryPolicy</c> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><c>FilterPolicy</c> – 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><c>FilterPolicyScope</c> – This attribute lets you choose the filtering scope by using one of the following string value types:</para><ul><li><para><c>MessageAttributes</c> (default) – The filter is applied on the message attributes.</para></li><li><para><c>MessageBody</c> – The filter is applied on the message body.</para></li></ul></li><li><para><c>RawMessageDelivery</c> – When set to <c>true</c>, 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><li><para><c>RedrivePolicy</c> – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.</para></li></ul><para>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</para><ul><li><para><c>SubscriptionRoleArn</c> – The ARN of the IAM role that has the following:</para><ul><li><para>Permission to write to the Firehose delivery stream</para></li><li><para>Amazon SNS listed as a trusted entity</para></li></ul><para>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</para></li></ul><para>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</para><ul><li><para><c>ReplayPolicy</c> – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.</para></li><li><para><c>ReplayStatus</c> – Retrieves the status of the subscription message replay, which can be one of the following:</para><ul><li><para><c>Completed</c> – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the <c>ReplayPolicy</c> then the subscription will no longer receive newly published messages.</para></li><li><para><c>In progress</c> – The replay is currently replaying the selected messages.</para></li><li><para><c>Failed</c> – The replay was unable to complete.</para></li><li><para><c>Pending</c> – The default state while the replay initiates.</para></li></ul></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 <c>http</c> protocol, the (public) endpoint is a URL beginning with <c>http://</c>.</para></li><li><para>For the <c>https</c> protocol, the (public) endpoint is a URL beginning with <c>https://</c>.</para></li><li><para>For the <c>email</c> protocol, the endpoint is an email address.</para></li><li><para>For the <c>email-json</c> protocol, the endpoint is an email address.</para></li><li><para>For the <c>sms</c> protocol, the endpoint is a phone number of an SMS-enabled device.</para></li><li><para>For the <c>sqs</c> protocol, the endpoint is the ARN of an Amazon SQS queue.</para></li><li><para>For the <c>application</c> protocol, the endpoint is the EndpointArn of a mobile app and device.</para></li><li><para>For the <c>lambda</c> protocol, the endpoint is the ARN of an Lambda function.</para></li><li><para>For the <c>firehose</c> protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.Protocol"> <summary> <para> <para>The protocol that you want to use. Supported protocols include:</para><ul><li><para><c>http</c> – delivery of JSON-encoded message via HTTP POST</para></li><li><para><c>https</c> – delivery of JSON-encoded message via HTTPS POST</para></li><li><para><c>email</c> – delivery of message via SMTP</para></li><li><para><c>email-json</c> – delivery of JSON-encoded message via SMTP</para></li><li><para><c>sms</c> – delivery of message via SMS</para></li><li><para><c>sqs</c> – delivery of JSON-encoded message to an Amazon SQS queue</para></li><li><para><c>application</c> – delivery of JSON-encoded message to an EndpointArn for a mobile app and device</para></li><li><para><c>lambda</c> – delivery of JSON-encoded message to an Lambda function</para></li><li><para><c>firehose</c> – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.ReturnSubscriptionArn"> <summary> <para> <para>Sets whether the response from the <c>Subscribe</c> request includes the subscription ARN, even if the subscription is not yet confirmed.</para><para>If you set this parameter to <c>true</c>, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the <c>pending subscription</c> ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the <c>ConfirmSubscription</c> action with a confirmation token.</para><para>The default value is <c>false</c>.</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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SubscriptionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.SubscribeResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.SubscribeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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 Amazon Web Services signature is required. If the <c>Unsubscribe</c> 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 <c>Unsubscribe</c> request was unintended. <note><para> Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature. </para></note><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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.UnsubscribeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscriptionArn parameter. The -PassThru parameter is deprecated, use -Select '^SubscriptionArn' instead. This parameter will be removed in a future version. </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. Use E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.EnableSNSPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.OptInPhoneNumberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.EnableSNSPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumber parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumber' instead. This parameter will be removed in a future version. </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.GetSNSDataProtectionPolicyCmdlet"> <summary> Retrieves the specified inline <c>DataProtectionPolicy</c> document that is stored in the specified Amazon SNS topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSDataProtectionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the topic whose <c>DataProtectionPolicy</c> you want to get.</para><para>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSDataProtectionPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataProtectionPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.GetDataProtectionPolicyResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.GetDataProtectionPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSDataProtectionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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 (Firebase Cloud Messaging) 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><c>EndpointArn</c> for <c>GetEndpointAttributes</c> input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.GetEndpointAttributesResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.GetEndpointAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </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 (Firebase Cloud Messaging) and APNS. The results for <c>ListEndpointsByPlatformApplication</c> 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 <c>ListEndpointsByPlatformApplication</c> 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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.PlatformApplicationArn"> <summary> <para> <para><c>PlatformApplicationArn</c> for <c>ListEndpointsByPlatformApplicationInput</c> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.NextToken"> <summary> <para> <para><c>NextToken</c> string is used when calling <c>ListEndpointsByPlatformApplication</c> 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlatformApplicationArn parameter. The -PassThru parameter is deprecated, use -Select '^PlatformApplicationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSOriginationNumberCmdlet"> <summary> Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see <a href="https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html">Origination numbers</a> in the <i>Amazon SNS Developer Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSOriginationNumberCmdlet.MaxResult"> <summary> <para> <para>The maximum number of origination numbers to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSOriginationNumberCmdlet.NextToken"> <summary> <para> <para>Token that the previous <c>ListOriginationNumbers</c> request returns.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSOriginationNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PhoneNumbers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListOriginationNumbersResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListOriginationNumbersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSOriginationNumberCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>ListPhoneNumbersOptedOut</c> 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 <c>NextToken</c> string will be returned. To receive the next page, you call <c>ListPhoneNumbersOptedOut</c> again using the <c>NextToken</c> string received from the previous call. When there are no more records to return, <c>NextToken</c> will be null. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPhoneNumbersOptedOutCmdlet.NextToken"> <summary> <para> <para>A <c>NextToken</c> string is used when you call the <c>ListPhoneNumbersOptedOut</c> 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPhoneNumbersOptedOutCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PhoneNumbers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListPhoneNumbersOptedOutResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListPhoneNumbersOptedOutResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPhoneNumbersOptedOutCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 (Firebase Cloud Messaging). 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><c>PlatformApplicationArn</c> for GetPlatformApplicationAttributesInput.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.GetPlatformApplicationAttributesResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.GetPlatformApplicationAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlatformApplicationArn parameter. The -PassThru parameter is deprecated, use -Select '^PlatformApplicationArn' instead. This parameter will be removed in a future version. </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 (Firebase Cloud Messaging). The results for <c>ListPlatformApplications</c> 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 <c>ListPlatformApplications</c> using the NextToken string received from the previous call. When there are no more records to return, <c>NextToken</c> 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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationListCmdlet.NextToken"> <summary> <para> <para><c>NextToken</c> string is used when calling <c>ListPlatformApplications</c> 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PlatformApplications'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListPlatformApplicationsResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListPlatformApplicationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSAttributeCmdlet"> <summary> Returns the settings for sending SMS messages from your Amazon Web Services account. <para> These settings are set with the <c>SetSMSAttributes</c> 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 <c>MonthlySpendLimit</c>, 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="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.GetSMSAttributesResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.GetSMSAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Attribute parameter. The -PassThru parameter is deprecated, use -Select '^Attribute' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSSandboxAccountStatusCmdlet"> <summary> Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region. <para> When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSSandboxAccountStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IsInSandbox'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.GetSMSSandboxAccountStatusResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.GetSMSSandboxAccountStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSSandboxPhoneNumberCmdlet"> <summary> Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox. <para> When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSSandboxPhoneNumberCmdlet.MaxResult"> <summary> <para> <para>The maximum number of phone numbers to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSSandboxPhoneNumberCmdlet.NextToken"> <summary> <para> <para>Token that the previous <c>ListSMSSandboxPhoneNumbersInput</c> request returns.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSSandboxPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PhoneNumbers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListSMSSandboxPhoneNumbersResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListSMSSandboxPhoneNumbersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSMSSandboxPhoneNumberCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>NextToken</c> is also returned. Use the <c>NextToken</c> parameter in a new <c>ListSubscriptions</c> call to get further results. <para> This action is throttled at 30 transactions per second (TPS). </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <c>ListSubscriptions</c> 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Subscriptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListSubscriptionsResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListSubscriptionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.GetSubscriptionAttributesResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.GetSubscriptionAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscriptionArn parameter. The -PassThru parameter is deprecated, use -Select '^SubscriptionArn' instead. This parameter will be removed in a future version. </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 <c>NextToken</c> is also returned. Use the <c>NextToken</c> parameter in a new <c>ListSubscriptionsByTopic</c> call to get further results. <para> This action is throttled at 30 transactions per second (TPS). </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 <c>ListSubscriptionsByTopic</c> 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Subscriptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListSubscriptionsByTopicResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListSubscriptionsByTopicResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>NextToken</c> is also returned. Use the <c>NextToken</c> parameter in a new <c>ListTopics</c> call to get further results. <para> This action is throttled at 30 transactions per second (TPS). </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <c>ListTopics</c> 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Topics'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.ListTopicsResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.ListTopicsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.GetTopicAttributesResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.GetTopicAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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 GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify <c>PlatformPrincipal</c> and <c>PlatformCredential</c> attributes when using the <c>CreatePlatformApplication</c> action. <para><c>PlatformPrincipal</c> and <c>PlatformCredential</c> are received from the notification service. </para><ul><li><para> For ADM, <c>PlatformPrincipal</c> is <c>client id</c> and <c>PlatformCredential</c> is <c>client secret</c>. </para></li><li><para> For APNS and <c>APNS_SANDBOX</c> using certificate credentials, <c>PlatformPrincipal</c> is <c>SSL certificate</c> and <c>PlatformCredential</c> is <c>private key</c>. </para></li><li><para> For APNS and <c>APNS_SANDBOX</c> using token credentials, <c>PlatformPrincipal</c> is <c>signing key ID</c> and <c>PlatformCredential</c> is <c>signing key</c>. </para></li><li><para> For Baidu, <c>PlatformPrincipal</c> is <c>API key</c> and <c>PlatformCredential</c> is <c>secret key</c>. </para></li><li><para> For GCM (Firebase Cloud Messaging) using key credentials, there is no <c>PlatformPrincipal</c>. The <c>PlatformCredential</c> is <c>API key</c>. </para></li><li><para> For GCM (Firebase Cloud Messaging) using token credentials, there is no <c>PlatformPrincipal</c>. The <c>PlatformCredential</c> is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: <c>SERVICE_JSON=`jq @json <<< cat service.json`</c>. </para></li><li><para> For MPNS, <c>PlatformPrincipal</c> is <c>TLS certificate</c> and <c>PlatformCredential</c> is <c>private key</c>. </para></li><li><para> For WNS, <c>PlatformPrincipal</c> is <c>Package Security Identifier</c> and <c>PlatformCredential</c> is <c>secret key</c>. </para></li></ul><para> You can use the returned <c>PlatformApplicationArn</c> as an attribute for the <c>CreatePlatformEndpoint</c> action. </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"><c>SetPlatformApplicationAttributes</c></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 (Firebase Cloud Messaging).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PlatformApplicationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.CreatePlatformApplicationResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.CreatePlatformApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </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 (Firebase Cloud Messaging) and APNS. <c>CreatePlatformEndpoint</c> requires the <c>PlatformApplicationArn</c> that is returned from <c>CreatePlatformApplication</c>. You can use the returned <c>EndpointArn</c> to send a message to a mobile app or by the <c>Subscribe</c> action for subscription to a topic. The <c>CreatePlatformEndpoint</c> 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 <c>CreatePlatformEndpoint</c> 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"><c>SetEndpointAttributes</c></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><c>PlatformApplicationArn</c> 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 (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.CreatePlatformEndpointResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.CreatePlatformEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlatformApplicationArn parameter. The -PassThru parameter is deprecated, use -Select '^PlatformApplicationArn' instead. This parameter will be removed in a future version. </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.NewSNSSMSSandboxPhoneNumberCmdlet"> <summary> Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number. <para> When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSSMSSandboxPhoneNumberCmdlet.LanguageCode"> <summary> <para> <para>The language to use for sending the OTP. The default value is <c>en-US</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSSMSSandboxPhoneNumberCmdlet.PhoneNumber"> <summary> <para> <para>The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSSMSSandboxPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.CreateSMSSandboxPhoneNumberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSSMSSandboxPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumber parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumber' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSSMSSandboxPhoneNumberCmdlet.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 standard topics (at most 1,000 FIFO topics). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html">Creating an Amazon SNS topic</a> in the <i>Amazon SNS Developer Guide</i>. 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 names, descriptions, and values of the special request parameters that the <c>CreateTopic</c> action uses:</para><ul><li><para><c>DeliveryPolicy</c> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><c>DisplayName</c> – The display name to use for a topic with SMS subscriptions.</para></li><li><para><c>FifoTopic</c> – Set to true to create a FIFO topic.</para></li><li><para><c>Policy</c> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</para></li><li><para><c>SignatureVersion</c> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <c>SignatureVersion</c> is set to <c>1</c>.</para></li><li><para><c>TracingConfig</c> – Tracing mode of an Amazon SNS topic. By default <c>TracingConfig</c> is set to <c>PassThrough</c>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to <c>Active</c>, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</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><c>KmsMasterKeyId</c> – The ID of an Amazon Web Services 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>Key Management Service API Reference</i>. </para></li></ul><para>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</para><ul><li><para><c>ArchivePolicy</c> – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.</para></li><li><para><c>ContentBasedDeduplication</c> – Enables content-based deduplication for FIFO topics.</para><ul><li><para>By default, <c>ContentBasedDeduplication</c> is set to <c>false</c>. If you create a FIFO topic and this attribute is <c>false</c>, you must specify a value for the <c>MessageDeduplicationId</c> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </para></li><li><para>When you set <c>ContentBasedDeduplication</c> to <c>true</c>, Amazon SNS uses a SHA-256 hash to generate the <c>MessageDeduplicationId</c> using the body of the message (but not the attributes of the message).</para><para>(Optional) To override the generated value, you can specify a value for the <c>MessageDeduplicationId</c> parameter for the <c>Publish</c> action.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.DataProtectionPolicy"> <summary> <para> <para>The body of the policy document you want to use for this topic.</para><para>You can only add one policy per topic.</para><para>The policy must be in JSON string format.</para><para>Length Constraints: Maximum length of 30,720.</para> </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>For a FIFO (first-in-first-out) topic, the name must end with the <c>.fifo</c> suffix. </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><note><para>To be able to tag a topic on creation, you must have the <c>sns:CreateTopic</c> and <c>sns:TagResource</c> permissions.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TopicArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.CreateTopicResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.CreateTopicResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </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.PublishSNSBatchCmdlet"> <summary> Publishes up to ten messages to the specified topic. This is a batch version of <c>Publish</c>. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes. <para> The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <c>200</c>. </para><para> The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). </para><para> Some actions take lists of parameters. These lists are specified using the <c>param.n</c> notation. Values of <c>n</c> are integers starting from 1. For example, a parameter list with two elements looks like this: </para><para> &AttributeName.1=first </para><para> &AttributeName.2=second </para><para> If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint. </para><para> When a <c>messageId</c> is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSBatchCmdlet.PublishBatchRequestEntry"> <summary> <para> <para>A list of <c>PublishBatch</c> request entries to be sent to the SNS topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSBatchCmdlet.TopicArn"> <summary> <para> <para>The Amazon resource name (ARN) of the topic you want to batch publish to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.PublishBatchResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.PublishBatchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSBatchCmdlet.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, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the <c>TargetArn</c>). <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 <c>messageId</c> is returned, the message is saved and Amazon SNS immediately delivers it to subscribers. </para><para> To use the <c>Publish</c> action for publishing 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 <c>CreatePlatformEndpoint</c> 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><important><para> You can publish messages only to topics and endpoints in the same Amazon Web Services Region. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.Message"> <summary> <para> <para>The message you want to send.</para><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 <c>MessageStructure</c> parameter to <c>json</c> and use a JSON object for the <c>Message</c> 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 <c>Publish</c> 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 <c>Publish</c> 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.MessageDeduplicationId"> <summary> <para> <para>This parameter applies only to FIFO (first-in-first-out) topics. The <c>MessageDeduplicationId</c> can contain up to 128 alphanumeric characters <c>(a-z, A-Z, 0-9)</c> and punctuation <c>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</c>.</para><para>Every message must have a unique <c>MessageDeduplicationId</c>, which is a token used for deduplication of sent messages. If a message with a particular <c>MessageDeduplicationId</c> is sent successfully, any message sent with the same <c>MessageDeduplicationId</c> during the 5-minute deduplication interval is treated as a duplicate. </para><para>If the topic has <c>ContentBasedDeduplication</c> set, the system generates a <c>MessageDeduplicationId</c> based on the contents of the message. Your <c>MessageDeduplicationId</c> overrides the generated one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.MessageGroupId"> <summary> <para> <para>This parameter applies only to FIFO (first-in-first-out) topics. The <c>MessageGroupId</c> can contain up to 128 alphanumeric characters <c>(a-z, A-Z, 0-9)</c> and punctuation <c>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</c>.</para><para>The <c>MessageGroupId</c> is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a <c>MessageGroupId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.MessageStructure"> <summary> <para> <para>Set <c>MessageStructure</c> to <c>json</c> 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 <c>MessageStructure</c> to <c>json</c>, the value of the <c>Message</c> 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>Valid value: <c>json</c></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 <c>PhoneNumber</c> parameter, you must specify a value for the <c>TargetArn</c> or <c>TopicArn</c> 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 UTF-8 text with no line breaks or control characters, and 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 <c>TargetArn</c> parameter, you must specify a value for the <c>PhoneNumber</c> or <c>TopicArn</c> 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 <c>TopicArn</c> parameter, you must specify a value for the <c>PhoneNumber</c> or <c>TargetArn</c> parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MessageId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.PublishResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.PublishResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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><c>EndpointArn</c> of endpoint to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.DeleteEndpointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </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. <note><para> To remove the ability to change topic permissions, you must deny permissions to the <c>AddPermission</c>, <c>RemovePermission</c>, and <c>SetTopicAttributes</c> actions in your IAM policy. </para></note> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.RemovePermissionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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 (Firebase Cloud Messaging). 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><c>PlatformApplicationArn</c> of platform application object to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.DeletePlatformApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlatformApplicationArn parameter. The -PassThru parameter is deprecated, use -Select '^PlatformApplicationArn' instead. This parameter will be removed in a future version. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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.RemoveSNSSMSSandboxPhoneNumberCmdlet"> <summary> Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox. <para> When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSSMSSandboxPhoneNumberCmdlet.PhoneNumber"> <summary> <para> <para>The destination phone number to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSSMSSandboxPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.DeleteSMSSandboxPhoneNumberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSSMSSandboxPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumber parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumber' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSSMSSandboxPhoneNumberCmdlet.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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.DeleteTopicResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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.SetSNSDataProtectionPolicyCmdlet"> <summary> Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSDataProtectionPolicyCmdlet.DataProtectionPolicy"> <summary> <para> <para>The JSON serialization of the topic's <c>DataProtectionPolicy</c>.</para><para>The <c>DataProtectionPolicy</c> must be in JSON string format.</para><para>Length Constraints: Maximum length of 30,720.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSDataProtectionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the topic whose <c>DataProtectionPolicy</c> you want to add or update.</para><para>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSDataProtectionPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.PutDataProtectionPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSDataProtectionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSDataProtectionPolicyCmdlet.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 (Firebase Cloud Messaging) 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><c>CustomUserData</c> – 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><c>Enabled</c> – 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><c>Token</c> – 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 <c>SetEndpointAttributes</c> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.SetEndpointAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </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 (Firebase Cloud Messaging). 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><c>PlatformCredential</c> – The credential received from the notification service.</para><ul><li><para>For ADM, <c>PlatformCredential</c>is client secret.</para></li><li><para>For Apple Services using certificate credentials, <c>PlatformCredential</c> is private key.</para></li><li><para>For Apple Services using token credentials, <c>PlatformCredential</c> is signing key.</para></li><li><para>For GCM (Firebase Cloud Messaging) using key credentials, there is no <c>PlatformPrincipal</c>. The <c>PlatformCredential</c> is <c>API key</c>.</para></li><li><para>For GCM (Firebase Cloud Messaging) using token credentials, there is no <c>PlatformPrincipal</c>. The <c>PlatformCredential</c> is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: <c>SERVICE_JSON=`jq @json <<< cat service.json`</c>.</para></li></ul></li></ul><ul><li><para><c>PlatformPrincipal</c> – The principal received from the notification service.</para><ul><li><para>For ADM, <c>PlatformPrincipal</c>is client id.</para></li><li><para>For Apple Services using certificate credentials, <c>PlatformPrincipal</c> is SSL certificate.</para></li><li><para>For Apple Services using token credentials, <c>PlatformPrincipal</c> is signing key ID.</para></li><li><para>For GCM (Firebase Cloud Messaging), there is no <c>PlatformPrincipal</c>. </para></li></ul></li></ul><ul><li><para><c>EventEndpointCreated</c> – Topic ARN to which <c>EndpointCreated</c> event notifications are sent.</para></li><li><para><c>EventEndpointDeleted</c> – Topic ARN to which <c>EndpointDeleted</c> event notifications are sent.</para></li><li><para><c>EventEndpointUpdated</c> – Topic ARN to which <c>EndpointUpdate</c> event notifications are sent.</para></li><li><para><c>EventDeliveryFailure</c> – Topic ARN to which <c>DeliveryFailure</c> event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</para></li><li><para><c>SuccessFeedbackRoleArn</c> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</para></li><li><para><c>FailureFeedbackRoleArn</c> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</para></li><li><para><c>SuccessFeedbackSampleRate</c> – Sample rate percentage (0-100) of successfully delivered messages.</para></li></ul><para>The following attributes only apply to <c>APNs</c> token-based authentication:</para><ul><li><para><c>ApplePlatformTeamID</c> – The identifier that's assigned to your Apple developer account team.</para></li><li><para><c>ApplePlatformBundleID</c> – The bundle identifier that's assigned to your iOS app.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet.PlatformApplicationArn"> <summary> <para> <para><c>PlatformApplicationArn</c> for <c>SetPlatformApplicationAttributes</c> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.SetPlatformApplicationAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlatformApplicationArn parameter. The -PassThru parameter is deprecated, use -Select '^PlatformApplicationArn' instead. This parameter will be removed in a future version. </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 <c>Publish</c> action with the <c>MessageAttributes.entry.N</c> parameter. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>. </para><note><para> To use this operation, you must grant the Amazon SNS service principal (<c>sns.amazonaws.com</c>) permission to perform the <c>s3:ListBucket</c> action. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSMSAttributeCmdlet.Attribute"> <summary> <para> <para>The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:</para><para><c>MonthlySpendLimit</c> – 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><c>DeliveryStatusIAMRole</c> – 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><c>DeliveryStatusSuccessSamplingRate</c> – 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 <c>0</c>. To write logs for 10% of your successful deliveries, set it to <c>10</c>.</para><para><c>DefaultSenderID</c> – 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><c>DefaultSMSType</c> – The type of SMS message that you will send by default. You can assign the following values:</para><ul><li><para><c>Promotional</c> – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.</para></li><li><para><c>Transactional</c> – 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><c>UsageReportS3Bucket</c> – 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 Amazon Web Services 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 principal to perform the <c>s3:PutObject</c> and <c>s3:GetBucketLocation</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.SetSMSAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSMSAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Attribute parameter. The -PassThru parameter is deprecated, use -Select '^Attribute' instead. This parameter will be removed in a future version. </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 this action uses:</para><ul><li><para><c>DeliveryPolicy</c> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><c>FilterPolicy</c> – 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><c>FilterPolicyScope</c> – This attribute lets you choose the filtering scope by using one of the following string value types:</para><ul><li><para><c>MessageAttributes</c> (default) – The filter is applied on the message attributes.</para></li><li><para><c>MessageBody</c> – The filter is applied on the message body.</para></li></ul></li><li><para><c>RawMessageDelivery</c> – When set to <c>true</c>, 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><li><para><c>RedrivePolicy</c> – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.</para></li></ul><para>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</para><ul><li><para><c>SubscriptionRoleArn</c> – The ARN of the IAM role that has the following:</para><ul><li><para>Permission to write to the Firehose delivery stream</para></li><li><para>Amazon SNS listed as a trusted entity</para></li></ul><para>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.SetSubscriptionAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscriptionArn parameter. The -PassThru parameter is deprecated, use -Select '^SubscriptionArn' instead. This parameter will be removed in a future version. </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. <note><para> To remove the ability to change topic permissions, you must deny permissions to the <c>AddPermission</c>, <c>RemovePermission</c>, and <c>SetTopicAttributes</c> actions in your IAM policy. </para></note> </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 <c>SetTopicAttributes</c> action uses:</para><ul><li><para><c>ApplicationSuccessFeedbackRoleArn</c> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.</para></li><li><para><c>DeliveryPolicy</c> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</para></li><li><para><c>DisplayName</c> – The display name to use for a topic with SMS subscriptions.</para></li><li><para><c>Policy</c> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</para></li><li><para><c>TracingConfig</c> – Tracing mode of an Amazon SNS topic. By default <c>TracingConfig</c> is set to <c>PassThrough</c>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to <c>Active</c>, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</para></li><li><para>HTTP</para><ul><li><para><c>HTTPSuccessFeedbackRoleArn</c> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. </para></li><li><para><c>HTTPSuccessFeedbackSampleRate</c> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.</para></li><li><para><c>HTTPFailureFeedbackRoleArn</c> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.</para></li></ul></li><li><para>Amazon Kinesis Data Firehose</para><ul><li><para><c>FirehoseSuccessFeedbackRoleArn</c> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.</para></li><li><para><c>FirehoseSuccessFeedbackSampleRate</c> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.</para></li><li><para><c>FirehoseFailureFeedbackRoleArn</c> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint. </para></li></ul></li><li><para>Lambda</para><ul><li><para><c>LambdaSuccessFeedbackRoleArn</c> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.</para></li><li><para><c>LambdaSuccessFeedbackSampleRate</c> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.</para></li><li><para><c>LambdaFailureFeedbackRoleArn</c> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. </para></li></ul></li><li><para>Platform application endpoint</para><ul><li><para><c>ApplicationSuccessFeedbackRoleArn</c> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</para></li><li><para><c>ApplicationSuccessFeedbackSampleRate</c> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</para></li><li><para><c>ApplicationFailureFeedbackRoleArn</c> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</para></li></ul><note><para>In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.</para><para>For example, For more information, 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>. </para></note></li><li><para>Amazon SQS</para><ul><li><para><c>SQSSuccessFeedbackRoleArn</c> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </para></li><li><para><c>SQSSuccessFeedbackSampleRate</c> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </para></li><li><para><c>SQSFailureFeedbackRoleArn</c> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </para></li></ul></li></ul><note><para>The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. </para></note><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><c>KmsMasterKeyId</c> – The ID of an Amazon Web Services 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>Key Management Service API Reference</i>. </para></li><li><para><c>SignatureVersion</c> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <c>SignatureVersion</c> is set to <c>1</c>.</para></li></ul><para>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</para><ul><li><para><c>ArchivePolicy</c> – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.</para></li><li><para><c>ContentBasedDeduplication</c> – Enables content-based deduplication for FIFO topics.</para><ul><li><para>By default, <c>ContentBasedDeduplication</c> is set to <c>false</c>. If you create a FIFO topic and this attribute is <c>false</c>, you must specify a value for the <c>MessageDeduplicationId</c> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </para></li><li><para>When you set <c>ContentBasedDeduplication</c> to <c>true</c>, Amazon SNS uses a SHA-256 hash to generate the <c>MessageDeduplicationId</c> using the body of the message (but not the attributes of the message).</para><para>(Optional) To override the generated value, you can specify a value for the <c>MessageDeduplicationId</c> parameter for the <c>Publish</c> action.</para></li></ul></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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.SetTopicAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicArn parameter. The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. </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 Amazon Web Services 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 <c>OptInPhoneNumber</c> 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> <member name="P:Amazon.PowerShell.Cmdlets.SNS.TestSNSIfPhoneNumberIsOptedOutCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IsOptedOut'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.CheckIfPhoneNumberIsOptedOutResponse). Specifying the name of a property of type Amazon.SimpleNotificationService.Model.CheckIfPhoneNumberIsOptedOutResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.TestSNSIfPhoneNumberIsOptedOutCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumber parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumber' instead. This parameter will be removed in a future version. </summary> </member> </members> </doc> |