AWS.Tools.SSMQuickSetup.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SSMQuickSetup</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SSMQS.AddSSMQSResourceTagCmdlet"> <summary> Assigns key-value pairs of metadata to Amazon Web Services resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.AddSSMQSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.AddSSMQSResourceTagCmdlet.Tag"> <summary> <para> <para>Key-value pairs of metadata to assign to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.AddSSMQSResourceTagCmdlet.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.SSMQuickSetup.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.AddSSMQSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.AddSSMQSResourceTagCmdlet.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.SSMQS.GetSSMQSConfigurationCmdlet"> <summary> Returns details about the specified configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationCmdlet.ConfigurationId"> <summary> <para> <para>A service generated identifier for the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationCmdlet.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.SSMQuickSetup.Model.GetConfigurationResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.GetConfigurationResponse 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.SSMQS.GetSSMQSConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationId parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationListCmdlet"> <summary> Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationListCmdlet.ConfigurationDefinitionId"> <summary> <para> <para>The ID of the configuration definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationListCmdlet.Filter"> <summary> <para> <para>Filters the results returned by the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationListCmdlet.ManagerArn"> <summary> <para> <para>The ARN of the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationListCmdlet.StartingToken"> <summary> <para> <para>The token to use when requesting a specific set of items from a list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationListCmdlet.MaxItem"> <summary> <para> <para>Specifies the maximum number of configurations that are returned by the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMQuickSetup.Model.ListConfigurationsResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.ListConfigurationsResponse 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="T:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerCmdlet"> <summary> Returns a configuration manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerCmdlet.ManagerArn"> <summary> <para> <para>The ARN of the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerCmdlet.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.SSMQuickSetup.Model.GetConfigurationManagerResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.GetConfigurationManagerResponse 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.SSMQS.GetSSMQSConfigurationManagerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ManagerArn parameter. The -PassThru parameter is deprecated, use -Select '^ManagerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerListCmdlet"> <summary> Returns Quick Setup configuration managers.<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.SSMQS.GetSSMQSConfigurationManagerListCmdlet.Filter"> <summary> <para> <para>Filters the results returned by the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerListCmdlet.MaxItem"> <summary> <para> <para>Specifies the maximum number of configuration managers that are returned by the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerListCmdlet.StartingToken"> <summary> <para> <para>The token to use when requesting a specific set of items from a list.</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/>'StartingToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-StartingToken' to null for the first call then set the 'StartingToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationManagersList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMQuickSetup.Model.ListConfigurationManagersResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.ListConfigurationManagersResponse 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.SSMQS.GetSSMQSConfigurationManagerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSConfigurationManagerListCmdlet.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 StartingToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSQuickSetupTypeListCmdlet"> <summary> Returns the available Quick Setup types. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSQuickSetupTypeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickSetupTypeList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMQuickSetup.Model.ListQuickSetupTypesResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.ListQuickSetupTypesResponse 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="T:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSResourceTagCmdlet"> <summary> Returns tags assigned to the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource the tag is assigned to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMQuickSetup.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.ListTagsForResourceResponse 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.SSMQS.GetSSMQSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSServiceSettingCmdlet"> <summary> Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.GetSSMQSServiceSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMQuickSetup.Model.GetServiceSettingsResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.GetServiceSettingsResponse 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="T:Amazon.PowerShell.Cmdlets.SSMQS.NewSSMQSConfigurationManagerCmdlet"> <summary> Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.NewSSMQSConfigurationManagerCmdlet.ConfigurationDefinition"> <summary> <para> <para>The definition of the Quick Setup configuration that the configuration manager deploys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.NewSSMQSConfigurationManagerCmdlet.Description"> <summary> <para> <para>A description of the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.NewSSMQSConfigurationManagerCmdlet.Name"> <summary> <para> <para>A name for the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.NewSSMQSConfigurationManagerCmdlet.Tag"> <summary> <para> <para>Key-value pairs of metadata to assign to the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.NewSSMQSConfigurationManagerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ManagerArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMQuickSetup.Model.CreateConfigurationManagerResponse). Specifying the name of a property of type Amazon.SSMQuickSetup.Model.CreateConfigurationManagerResponse 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.SSMQS.NewSSMQSConfigurationManagerCmdlet.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.SSMQS.NewSSMQSConfigurationManagerCmdlet.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.SSMQS.RemoveSSMQSConfigurationManagerCmdlet"> <summary> Deletes a configuration manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSConfigurationManagerCmdlet.ManagerArn"> <summary> <para> <para>The ID of the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSConfigurationManagerCmdlet.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.SSMQuickSetup.Model.DeleteConfigurationManagerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSConfigurationManagerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ManagerArn parameter. The -PassThru parameter is deprecated, use -Select '^ManagerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSConfigurationManagerCmdlet.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.SSMQS.RemoveSSMQSResourceTagCmdlet"> <summary> Removes tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSResourceTagCmdlet.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.SSMQuickSetup.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.RemoveSSMQSResourceTagCmdlet.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.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet"> <summary> Updates a Quick Setup configuration definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.Id"> <summary> <para> <para>The ID of the configuration definition you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.LocalDeploymentAdministrationRoleArn"> <summary> <para> <para>The ARN of the IAM role used to administrate local configuration deployments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.LocalDeploymentExecutionRoleName"> <summary> <para> <para>The name of the IAM role used to deploy local configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.ManagerArn"> <summary> <para> <para>The ARN of the configuration manager associated with the definition to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.Parameter"> <summary> <para> <para>The parameters for the configuration definition type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.TypeVersion"> <summary> <para> <para>The version of the Quick Setup type to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.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.SSMQuickSetup.Model.UpdateConfigurationDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationDefinitionCmdlet.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.SSMQS.UpdateSSMQSConfigurationManagerCmdlet"> <summary> Updates a Quick Setup configuration manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationManagerCmdlet.Description"> <summary> <para> <para>A description of the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationManagerCmdlet.ManagerArn"> <summary> <para> <para>The ARN of the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationManagerCmdlet.Name"> <summary> <para> <para>A name for the configuration manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationManagerCmdlet.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.SSMQuickSetup.Model.UpdateConfigurationManagerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationManagerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ManagerArn parameter. The -PassThru parameter is deprecated, use -Select '^ManagerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSConfigurationManagerCmdlet.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.SSMQS.UpdateSSMQSServiceSettingCmdlet"> <summary> Updates settings configured for Quick Setup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSServiceSettingCmdlet.ExplorerEnablingRoleArn"> <summary> <para> <para>The IAM role used to enable Explorer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSServiceSettingCmdlet.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.SSMQuickSetup.Model.UpdateServiceSettingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSServiceSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExplorerEnablingRoleArn parameter. The -PassThru parameter is deprecated, use -Select '^ExplorerEnablingRoleArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSMQS.UpdateSSMQSServiceSettingCmdlet.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> |