AWS.Tools.CognitoSync.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CognitoSync</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet"> <summary> Subscribes to receive notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet.DatasetName"> <summary> <para> <para>The name of the dataset to subcribe to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet.DeviceId"> <summary> <para> <para>The unique ID generated for this device by Cognito.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet.IdentityId"> <summary> <para> <para>Unique ID for this identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet.IdentityPoolId"> <summary> <para> <para>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.SubscribeToDatasetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.AddCGISDatasetSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISBulkPublishDetailCmdlet"> <summary> Get the status of the last BulkPublish operation for an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISBulkPublishDetailCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISBulkPublishDetailCmdlet.Select"> <summary> 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.CognitoSync.Model.GetBulkPublishDetailsResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.GetBulkPublishDetailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISBulkPublishDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISCognitoEventCmdlet"> <summary> Gets the events and the corresponding Lambda functions associated with an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISCognitoEventCmdlet.IdentityPoolId"> <summary> <para> <para>The Cognito Identity Pool ID for the request</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISCognitoEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.GetCognitoEventsResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.GetCognitoEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISCognitoEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetCmdlet"> <summary> Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetCmdlet.DatasetName"> <summary> <para> A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetCmdlet.IdentityId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Dataset'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.DescribeDatasetResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.DescribeDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet"> <summary> Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet.IdentityId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet.MaxResult"> <summary> <para> The maximum number of results to be returned. </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet.NextToken"> <summary> <para> A pagination token for obtaining the next page of results. </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Datasets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.ListDatasetsResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.ListDatasetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISDatasetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolConfigurationCmdlet"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolConfigurationCmdlet.IdentityPoolId"> <summary> <para> <para>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolConfigurationCmdlet.Select"> <summary> 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.CognitoSync.Model.GetIdentityPoolConfigurationResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageCmdlet"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityPoolUsage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.DescribeIdentityPoolUsageResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.DescribeIdentityPoolUsageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageListCmdlet"> <summary> Gets a list of identity pools registered with Cognito. <para> ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageListCmdlet.MaxResult"> <summary> <para> The maximum number of results to be returned. </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageListCmdlet.NextToken"> <summary> <para> A pagination token for obtaining the next page of results. </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityPoolUsages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.ListIdentityPoolUsageResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.ListIdentityPoolUsageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityPoolUsageListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityUsageCmdlet"> <summary> Gets usage information for an identity, including number of datasets and data usage. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityUsageCmdlet.IdentityId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityUsageCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityUsageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityUsage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.DescribeIdentityUsageResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.DescribeIdentityUsageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISIdentityUsageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet"> <summary> Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para><br/><br/>In the AWS.Tools.CognitoSync module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.DatasetName"> <summary> <para> A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.IdentityId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.LastSyncCount"> <summary> <para> The last server sync count for this record. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.SyncSessionToken"> <summary> <para> A token containing a session ID, identity ID, and expiration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.MaxResult"> <summary> <para> The maximum number of results to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.NextToken"> <summary> <para> A pagination token for obtaining the next page of results. </para> <para> <br/><b>Note:</b> In the AWS.Tools.CognitoSync module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.Select"> <summary> 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.CognitoSync.Model.ListRecordsResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.ListRecordsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.GetCGISRecordListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.PublishCGISBulkDatasetCmdlet"> <summary> Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.PublishCGISBulkDatasetCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.PublishCGISBulkDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityPoolId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.BulkPublishResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.BulkPublishResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.PublishCGISBulkDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.PublishCGISBulkDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet"> <summary> Registers a device to receive push sync notifications. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet.IdentityId"> <summary> <para> <para>The unique ID for this identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet.IdentityPoolId"> <summary> <para> <para>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet.Platform"> <summary> <para> <para>The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet.Token"> <summary> <para> <para>The push token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeviceId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.RegisterDeviceResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.RegisterDeviceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RegisterCGISDeviceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetCmdlet"> <summary> Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetCmdlet.DatasetName"> <summary> <para> A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetCmdlet.IdentityId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Dataset'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.DeleteDatasetResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.DeleteDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet"> <summary> Unsubscribes from receiving notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet.DatasetName"> <summary> <para> <para>The name of the dataset from which to unsubcribe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet.DeviceId"> <summary> <para> <para>The unique ID generated for this device by Cognito.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet.IdentityId"> <summary> <para> <para>Unique ID for this identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet.IdentityPoolId"> <summary> <para> <para>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.UnsubscribeFromDatasetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.RemoveCGISDatasetSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.SetCGISCognitoEventLambdaFunctionCmdlet"> <summary> Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISCognitoEventLambdaFunctionCmdlet.Event"> <summary> <para> <para>The events to configure</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISCognitoEventLambdaFunctionCmdlet.IdentityPoolId"> <summary> <para> <para>The Cognito Identity Pool to use when configuring Cognito Events</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISCognitoEventLambdaFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.SetCognitoEventsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISCognitoEventLambdaFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISCognitoEventLambdaFunctionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.SetCGISIdentityPoolConfigurationCmdlet"> <summary> Sets the necessary configuration for push sync. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISIdentityPoolConfigurationCmdlet.CognitoStream"> <summary> <para> Options to apply to this identity pool for Amazon Cognito streams. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISIdentityPoolConfigurationCmdlet.IdentityPoolId"> <summary> <para> <para>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISIdentityPoolConfigurationCmdlet.PushSync"> <summary> <para> <para>Options to apply to this identity pool for push synchronization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISIdentityPoolConfigurationCmdlet.Select"> <summary> 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.CognitoSync.Model.SetIdentityPoolConfigurationResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISIdentityPoolConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.SetCGISIdentityPoolConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet"> <summary> Posts updates to records and adds and deletes records for a dataset and user. <para> The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. </para><para> For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. </para><para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.ClientContext"> <summary> <para> Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.DatasetName"> <summary> <para> A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.DeviceId"> <summary> <para> <para>The unique ID generated for this device by Cognito.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.IdentityId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.IdentityPoolId"> <summary> <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.RecordPatch"> <summary> <para> A list of patch operations. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.SyncSessionToken"> <summary> <para> The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Records'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.UpdateRecordsResponse). Specifying the name of a property of type Amazon.CognitoSync.Model.UpdateRecordsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGIS.UpdateCGISRecordCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |