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 Chime SDK Identity RegisterAppInstanceUserEndpoint API operation.

Syntax

Register-CHMIDAppInstanceUserEndpoint
-AllowMessage <AllowMessages>
-AppInstanceUserArn <String>
-ClientRequestToken <String>
-EndpointAttributes_DeviceToken <String>
-Name <String>
-ResourceArn <String>
-Type <AppInstanceUserEndpointType>
-EndpointAttributes_VoipDeviceToken <String>
-Select <String>
-Force <SwitchParameter>

Description

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Parameters

-AllowMessage <AllowMessages>
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAllowMessages
-AppInstanceUserArn <String>
The ARN of the AppInstanceUser.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
The idempotency token for each client request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointAttributes_DeviceToken <String>
The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointAttributes_VoipDeviceToken <String>
The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
Required?False
Position?Named
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)
-Name <String>
The name of the AppInstanceUserEndpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceArn <String>
The ARN of the resource to which the endpoint belongs.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.ChimeSDKIdentity.Model.RegisterAppInstanceUserEndpointResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.RegisterAppInstanceUserEndpointResponse 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)
-Type <AppInstanceUserEndpointType>
The type of the AppInstanceUserEndpoint. Supported types:
  • APNS: The mobile notification service for an Apple device.
  • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
  • GCM: The mobile notification service for an Android device.
Populate the ResourceArn value of each type as PinpointAppArn.
Required?True
Position?Named
Accept pipeline input?True (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

Amazon.ChimeSDKIdentity.Model.RegisterAppInstanceUserEndpointResponse
This cmdlet returns an Amazon.ChimeSDKIdentity.Model.RegisterAppInstanceUserEndpointResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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