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

Invokes the UpdateEndpoint operation against Amazon Pinpoint.

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>
-Force <SwitchParameter>

Description

Use to update an endpoint.

Parameters

-ApplicationId <String>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-Demographic_AppVersion <String>
The version of the application associated with the endpoint.
Required?False
Position?Named
Accept pipeline input?False
-Demographic_Locale <String>
The endpoint locale 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?False
-Demographic_Make <String>
The endpoint make, such as such as Apple or Samsung.
Required?False
Position?Named
Accept pipeline input?False
-Demographic_Model <String>
The endpoint model, such as iPhone.
Required?False
Position?Named
Accept pipeline input?False
-Demographic_ModelVersion <String>
The endpoint model version.
Required?False
Position?Named
Accept pipeline input?False
-Demographic_Platform <String>
The endpoint platform, such as ios or android.
Required?False
Position?Named
Accept pipeline input?False
-Demographic_PlatformVersion <String>
The endpoint platform version.
Required?False
Position?Named
Accept pipeline input?False
-Demographic_Timezone <String>
The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
Required?False
Position?Named
Accept pipeline input?False
-EndpointId <String>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_Address <String>
The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_Attribute <Hashtable>
Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_ChannelType <ChannelType>
The channel type.Valid values: GCM | APNS | SMS | EMAIL
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_EffectiveDate <String>
The last time the endpoint was updated. Provided in ISO 8601 format.
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_EndpointStatus <String>
The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_Metric <Hashtable>
Custom metrics that your app reports to Amazon Pinpoint.
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_OptOut <String>
Indicates whether a user has opted out of receiving messages with one of the following values:ALL - User has opted out of all messages.NONE - Users has not opted out and receives all messages.
Required?False
Position?Named
Accept pipeline input?False
-EndpointRequest_RequestId <String>
The unique ID for the most recent request to update the endpoint.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-Location_City <String>
The city where the endpoint is located.
Required?False
Position?Named
Accept pipeline input?False
-Location_Country <String>
Country according to ISO 3166-1 Alpha-2 codes. For example, US.
Required?False
Position?Named
Accept pipeline input?False
-Location_Latitude <Double>
The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
Required?False
Position?Named
Accept pipeline input?False
-Location_Longitude <Double>
The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
Required?False
Position?Named
Accept pipeline input?False
-Location_PostalCode <String>
The postal code or zip code of the endpoint.
Required?False
Position?Named
Accept pipeline input?False
-Location_Region <String>
The region of the endpoint location. For example, corresponds to a state in US.
Required?False
Position?Named
Accept pipeline input?False
-User_UserAttribute <Hashtable>
Custom attributes specific to the user.
Required?False
Position?Named
Accept pipeline input?False
-User_UserId <String>
The unique ID of the user.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the ApplicationId parameter.

Outputs

This cmdlet returns a 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