AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Simple Notification Service (SNS) Subscribe API operation.

Syntax

Connect-SNSNotification
-TopicArn <String>
-Protocol <String>
-Endpoint <String>
-Attribute <Hashtable>
-ReturnSubscriptionArn <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSimpleNotificationServiceConfig>

Description

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 ConfirmSubscription action to confirm the subscription. You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for two days. This action is throttled at 100 transactions per second (TPS).

Parameters

-Attribute <Hashtable>
A map of attributes with their corresponding values.The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, 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.
  • RedrivePolicy – 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.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Kinesis Data Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
The following attributes apply only to FIFO topics:
  • ReplayPolicy – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
  • ReplayStatus – Retrieves the status of the subscription message replay, which can be one of the following:
    • Completed – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy then the subscription will no longer receive newly published messages.
    • In progress – The replay is currently replaying the selected messages.
    • Failed – The replay was unable to complete.
    • Pending – The default state while the replay initiates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes
-ClientConfig <AmazonSimpleNotificationServiceConfig>
Amazon.PowerShell.Cmdlets.SNS.AmazonSimpleNotificationServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Endpoint <String>
The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the (public) endpoint is a URL beginning with http://.
  • For the https protocol, the (public) endpoint is a URL beginning with https://.
  • For the email protocol, the endpoint is an email address.
  • For the email-json protocol, the endpoint is an email address.
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an Lambda function.
  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
Required?False
Position?3
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol <String>
The protocol that you want to use. Supported protocols include:
  • http – delivery of JSON-encoded message via HTTP POST
  • https – delivery of JSON-encoded message via HTTPS POST
  • email – delivery of message via SMTP
  • email-json – delivery of JSON-encoded message via SMTP
  • sms – delivery of message via SMS
  • sqs – delivery of JSON-encoded message to an Amazon SQS queue
  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
  • lambda – delivery of JSON-encoded message to an Lambda function
  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
Required?True
Position?2
Accept pipeline input?True (ByPropertyName)
-ReturnSubscriptionArn <Boolean>
Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.If you set this parameter to true, 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 pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.The default value is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicArn <String>
The ARN of the topic you want to subscribe to.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SimpleNotificationService.Model.SubscribeResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SimpleNotificationService.Model.SubscribeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z