AWS.Tools.Mobile.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Mobile</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLBundleCmdlet"> <summary> Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLBundleCmdlet.BundleId"> <summary> <para> <para> Unique bundle identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLBundleCmdlet.Platform"> <summary> <para> <para> Developer desktop or target application platform. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLBundleCmdlet.ProjectId"> <summary> <para> <para> Unique project identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLBundleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DownloadUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Mobile.Model.ExportBundleResponse). Specifying the name of a property of type Amazon.Mobile.Model.ExportBundleResponse 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.MOBL.ExportMOBLBundleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BundleId parameter. The -PassThru parameter is deprecated, use -Select '^BundleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLBundleCmdlet.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.MOBL.ExportMOBLProjectCmdlet"> <summary> Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLProjectCmdlet.ProjectId"> <summary> <para> <para> Unique project identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLProjectCmdlet.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.Mobile.Model.ExportProjectResponse). Specifying the name of a property of type Amazon.Mobile.Model.ExportProjectResponse 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.MOBL.ExportMOBLProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.ExportMOBLProjectCmdlet.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.MOBL.GetMOBLBundleCmdlet"> <summary> Get the bundle details for the requested bundle id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.GetMOBLBundleCmdlet.BundleId"> <summary> <para> <para> Unique bundle identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.GetMOBLBundleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Details'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Mobile.Model.DescribeBundleResponse). Specifying the name of a property of type Amazon.Mobile.Model.DescribeBundleResponse 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.MOBL.GetMOBLBundleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BundleId parameter. The -PassThru parameter is deprecated, use -Select '^BundleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MOBL.GetMOBLBundleListCmdlet"> <summary> List all available bundles.<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.MOBL.GetMOBLBundleListCmdlet.MaxResult"> <summary> <para> <para> Maximum number of records to list in a single response. </para> </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.MOBL.GetMOBLBundleListCmdlet.NextToken"> <summary> <para> <para> Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more bundles. </para> </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.MOBL.GetMOBLBundleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BundleList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Mobile.Model.ListBundlesResponse). Specifying the name of a property of type Amazon.Mobile.Model.ListBundlesResponse 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.MOBL.GetMOBLBundleListCmdlet.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.MOBL.GetMOBLProjectCmdlet"> <summary> Gets details about a project in AWS Mobile Hub. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.GetMOBLProjectCmdlet.ProjectId"> <summary> <para> <para> Unique project identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.GetMOBLProjectCmdlet.SyncFromResource"> <summary> <para> <para> If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.GetMOBLProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Details'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Mobile.Model.DescribeProjectResponse). Specifying the name of a property of type Amazon.Mobile.Model.DescribeProjectResponse 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.MOBL.GetMOBLProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MOBL.GetMOBLProjectListCmdlet"> <summary> Lists projects in AWS Mobile Hub.<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.MOBL.GetMOBLProjectListCmdlet.MaxResult"> <summary> <para> <para> Maximum number of records to list in a single response. </para> </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.MOBL.GetMOBLProjectListCmdlet.NextToken"> <summary> <para> <para> Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more projects. </para> </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.MOBL.GetMOBLProjectListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Projects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Mobile.Model.ListProjectsResponse). Specifying the name of a property of type Amazon.Mobile.Model.ListProjectsResponse 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.MOBL.GetMOBLProjectListCmdlet.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.MOBL.NewMOBLProjectCmdlet"> <summary> Creates an AWS Mobile Hub project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.NewMOBLProjectCmdlet.Content"> <summary> <para> <para> ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the contents of the file downloaded from the URL provided in an export project operation. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.NewMOBLProjectCmdlet.Name"> <summary> <para> <para> Name of the project. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.NewMOBLProjectCmdlet.ProjectRegion"> <summary> <para> <para> Default region where project resources should be created. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.NewMOBLProjectCmdlet.SnapshotId"> <summary> <para> <para> Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.NewMOBLProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Details'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Mobile.Model.CreateProjectResponse). Specifying the name of a property of type Amazon.Mobile.Model.CreateProjectResponse 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.MOBL.NewMOBLProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.NewMOBLProjectCmdlet.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.MOBL.RemoveMOBLProjectCmdlet"> <summary> Delets a project in AWS Mobile Hub. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.RemoveMOBLProjectCmdlet.ProjectId"> <summary> <para> <para> Unique project identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.RemoveMOBLProjectCmdlet.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.Mobile.Model.DeleteProjectResponse). Specifying the name of a property of type Amazon.Mobile.Model.DeleteProjectResponse 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.MOBL.RemoveMOBLProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.RemoveMOBLProjectCmdlet.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.MOBL.UpdateMOBLProjectCmdlet"> <summary> Update an existing project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.UpdateMOBLProjectCmdlet.Content"> <summary> <para> <para> ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file downloaded from the URL provided in an export project operation. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.UpdateMOBLProjectCmdlet.ProjectId"> <summary> <para> <para> Unique project identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.UpdateMOBLProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Details'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Mobile.Model.UpdateProjectResponse). Specifying the name of a property of type Amazon.Mobile.Model.UpdateProjectResponse 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.MOBL.UpdateMOBLProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MOBL.UpdateMOBLProjectCmdlet.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> |