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 UpdateSegment API operation.

Syntax

Update-PINSegment
-ApplicationId <String>
-Dimensions_Attribute <Hashtable>
-AppVersion_DimensionType <DimensionType>
-Channel_DimensionType <DimensionType>
-DeviceType_DimensionType <DimensionType>
-Make_DimensionType <DimensionType>
-Model_DimensionType <DimensionType>
-Platform_DimensionType <DimensionType>
-Country_DimensionType <DimensionType>
-Recency_Duration <Duration>
-SegmentGroups_Group <SegmentGroup[]>
-SegmentGroups_Include <Include>
-Coordinates_Latitude <Double>
-Coordinates_Longitude <Double>
-Dimensions_Metric <Hashtable>
-WriteSegmentRequest_Name <String>
-GPSPoint_RangeInKilometer <Double>
-Recency_RecencyType <RecencyType>
-SegmentId <String>
-WriteSegmentRequest_Tag <Hashtable>
-Dimensions_UserAttribute <Hashtable>
-AppVersion_Value <String[]>
-Channel_Value <String[]>
-DeviceType_Value <String[]>
-Make_Value <String[]>
-Model_Value <String[]>
-Platform_Value <String[]>
-Country_Value <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPinpointConfig>

Description

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

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)
-AppVersion_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_AppVersion_DimensionType
-AppVersion_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_AppVersion_Values
-Channel_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Channel_DimensionType
-Channel_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Channel_Values
-ClientConfig <AmazonPinpointConfig>
Amazon.PowerShell.Cmdlets.PIN.AmazonPinpointClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Coordinates_Latitude <Double>
The latitude coordinate of the location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Location_GPSPoint_Coordinates_Latitude
-Coordinates_Longitude <Double>
The longitude coordinate of the location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Location_GPSPoint_Coordinates_Longitude
-Country_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Location_Country_DimensionType
-Country_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Location_Country_Values
-DeviceType_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_DeviceType_DimensionType
-DeviceType_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_DeviceType_Values
-Dimensions_Attribute <Hashtable>
One or more custom attributes to use as criteria for the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Attributes
-Dimensions_Metric <Hashtable>
One or more custom metrics to use as criteria for the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Metrics
-Dimensions_UserAttribute <Hashtable>
One or more custom user attributes to use as criteria for the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_UserAttributes
-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)
-GPSPoint_RangeInKilometer <Double>
The range, in kilometers, from the GPS coordinates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Location_GPSPoint_RangeInKilometers
-Make_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Make_DimensionType
-Make_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Make_Values
-Model_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Model_DimensionType
-Model_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Model_Values
-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)
-Platform_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Platform_DimensionType
-Platform_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Demographic_Platform_Values
-Recency_Duration <Duration>
The duration to use when determining whether an endpoint is active or inactive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Behavior_Recency_Duration
-Recency_RecencyType <RecencyType>
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Dimensions_Behavior_Recency_RecencyType
-SegmentGroups_Group <SegmentGroup[]>
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_SegmentGroups_Groups
-SegmentGroups_Include <Include>
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_SegmentGroups_Include
-SegmentId <String>
The unique identifier for the segment.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'SegmentResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.UpdateSegmentResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateSegmentResponse 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)
-WriteSegmentRequest_Name <String>
The name of the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteSegmentRequest_Tag <Hashtable>
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteSegmentRequest_Tags

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

Amazon.Pinpoint.Model.SegmentResponse or Amazon.Pinpoint.Model.UpdateSegmentResponse
This cmdlet returns an Amazon.Pinpoint.Model.SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateSegmentResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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