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 Pinpoint UpdateEndpoint API operation.

Syntax

Update-PINEndpoint
-ApplicationId <String>
-EndpointRequest_Address <String>
-Demographic_AppVersion <String>
-EndpointRequest_Attribute <Hashtable>
-EndpointRequest_ChannelType <ChannelType>
-Location_City <String>
-Location_Country <String>
-EndpointRequest_EffectiveDate <String>
-EndpointId <String>
-EndpointRequest_EndpointStatus <String>
-Location_Latitude <Double>
-Demographic_Locale <String>
-Location_Longitude <Double>
-Demographic_Make <String>
-EndpointRequest_Metric <Hashtable>
-Demographic_Model <String>
-Demographic_ModelVersion <String>
-EndpointRequest_OptOut <String>
-Demographic_Platform <String>
-Demographic_PlatformVersion <String>
-Location_PostalCode <String>
-Location_Region <String>
-EndpointRequest_RequestId <String>
-Demographic_Timezone <String>
-User_UserAttribute <Hashtable>
-User_UserId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.

Parameters

-ApplicationId <String>
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Demographic_AppVersion <String>
The version of the app that's associated with the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_AppVersion
-Demographic_Locale <String>
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_Locale
-Demographic_Make <String>
The manufacturer of the endpoint device, such as Apple or Samsung.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_Make
-Demographic_Model <String>
The model name or number of the endpoint device, such as iPhone.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_Model
-Demographic_ModelVersion <String>
The model version of the endpoint device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_ModelVersion
-Demographic_Platform <String>
The platform of the endpoint device, such as iOS or Android.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_Platform
-Demographic_PlatformVersion <String>
The platform version of the endpoint device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_PlatformVersion
-Demographic_Timezone <String>
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Demographic_Timezone
-EndpointId <String>
The unique identifier for the endpoint.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointRequest_Address <String>
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointRequest_Attribute <Hashtable>
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Attributes
-EndpointRequest_ChannelType <ChannelType>
The channel to use when sending messages or push notifications to the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointRequest_EffectiveDate <String>
The date and time, in ISO 8601 format, when the endpoint is updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointRequest_EndpointStatus <String>
Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointRequest_Metric <Hashtable>
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Metrics
-EndpointRequest_OptOut <String>
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointRequest_RequestId <String>
The unique identifier for the most recent request to update the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-Location_City <String>
The name of the city where the endpoint is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Location_City
-Location_Country <String>
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Location_Country
-Location_Latitude <Double>
The latitude coordinate of the endpoint location, rounded to one decimal place.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Location_Latitude
-Location_Longitude <Double>
The longitude coordinate of the endpoint location, rounded to one decimal place.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Location_Longitude
-Location_PostalCode <String>
The postal or ZIP code for the area where the endpoint is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Location_PostalCode
-Location_Region <String>
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_Location_Region
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateEndpointResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateEndpointResponse 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)
-User_UserAttribute <Hashtable>
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_User_UserAttributes
-User_UserId <String>
The unique identifier for the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointRequest_User_UserId

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

This cmdlet returns an Amazon.Pinpoint.Model.MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdateEndpointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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