AWS.Tools.SimpleSystemsManagement.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SimpleSystemsManagement</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMLatestEC2ImageCmdlet"> <summary> Retrieves the latest EC2 AMIs (Amazon Machine Images) from AWS Systems Manager parameters by calling Get-SSMParametersByPath or Get-SSMParameterValue. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMLatestEC2ImageCmdlet.Path"> <summary> <para> The partial hierarchy for the parameter under the /aws/service/ prefix representing the type of images to list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMLatestEC2ImageCmdlet.ImageName"> <summary> <para> The name of the parameter containing the image information. Wildcard characters '*' and '?' can be used to filter multiple AMIs. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMParametersByPathCmdlet"> <summary> Retrieve information about one or more parameters in a specific hierarchy. <para> Request results are returned on a best-effort basis. If you specify <c>MaxResults</c> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <c>MaxResults</c>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <c>NextToken</c>. You can specify the <c>NextToken</c> in a subsequent call to get the next set of results. </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.SSM.GetSSMParametersByPathCmdlet.ParameterFilter"> <summary> <para> <para>Filters to limit the request results.</para><note><para>The following <c>Key</c> values are supported for <c>GetParametersByPath</c>: <c>Type</c>, <c>KeyId</c>, and <c>Label</c>.</para><para>The following <c>Key</c> values aren't supported for <c>GetParametersByPath</c>: <c>tag</c>, <c>DataType</c>, <c>Name</c>, <c>Path</c>, and <c>Tier</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParametersByPathCmdlet.Path"> <summary> <para> <para>The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: <c>/Finance/Prod/IAD/WinServ2016/license33 </c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParametersByPathCmdlet.Recursive"> <summary> <para> <para>Retrieve all parameters within a hierarchy.</para><important><para>If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path <c>/a</c>, then the user can also access <c>/a/b</c>. Even if a user has explicitly been denied access in IAM for parameter <c>/a/b</c>, they can still call the GetParametersByPath API operation recursively for <c>/a</c> and view <c>/a/b</c>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParametersByPathCmdlet.WithDecryption"> <summary> <para> <para>Retrieve all parameters in a hierarchy with their value decrypted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParametersByPathCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>10</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParametersByPathCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMParametersByPathCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Parameters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetParametersByPathResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetParametersByPathResponse 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.SSM.GetSSMParametersByPathCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Path parameter. The -PassThru parameter is deprecated, use -Select '^Path' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParametersByPathCmdlet.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.SSM.AddSSMResourceTagCmdlet"> <summary> Adds or overwrites one or more tags for the specified resource. <i>Tags</i> are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example: <ul><li><para><c>Key=Owner,Value=DbAdmin</c></para></li><li><para><c>Key=Owner,Value=SysAdmin</c></para></li><li><para><c>Key=Owner,Value=Dev</c></para></li><li><para><c>Key=Stack,Value=Production</c></para></li><li><para><c>Key=Stack,Value=Pre-Production</c></para></li><li><para><c>Key=Stack,Value=Test</c></para></li></ul><para> Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags. </para><para> We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. </para><para> For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tag your Amazon EC2 resources</a> in the <i>Amazon EC2 User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.AddSSMResourceTagCmdlet.ResourceId"> <summary> <para> <para>The resource ID you want to tag.</para><para>Use the ID of the resource. Here are some examples:</para><para><c>MaintenanceWindow</c>: <c>mw-012345abcde</c></para><para><c>PatchBaseline</c>: <c>pb-012345abcde</c></para><para><c>Automation</c>: <c>example-c160-4567-8519-012345abcde</c></para><para><c>OpsMetadata</c> object: <c>ResourceID</c> for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, <c>ResourceID</c> is created from the strings that come after the word <c>opsmetadata</c> in the ARN. For example, an OpsMetadata object with an ARN of <c>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</c> has a <c>ResourceID</c> of either <c>aws/ssm/MyGroup/appmanager</c> or <c>/aws/ssm/MyGroup/appmanager</c>.</para><para>For the <c>Document</c> and <c>Parameter</c> values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.</para><para><c>ManagedInstance</c>: <c>mi-012345abcde</c></para><note><para>The <c>ManagedInstance</c> type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: <c>mi-<i>ID_number</i></c>. For example, <c>mi-1a2b3c4d5e6f</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.AddSSMResourceTagCmdlet.ResourceType"> <summary> <para> <para>Specifies the type of resource you are tagging.</para><note><para>The <c>ManagedInstance</c> type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: <c>mi-<i>ID_number</i></c>. For example, <c>mi-1a2b3c4d5e6f</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.AddSSMResourceTagCmdlet.Tag"> <summary> <para> <para>One or more tags. The value parameter is required.</para><important><para>Don't enter personally identifiable information in this field.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.AddSSMResourceTagCmdlet.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.SimpleSystemsManagement.Model.AddTagsToResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.AddSSMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.AddSSMResourceTagCmdlet.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.SSM.EditSSMDocumentPermissionCmdlet"> <summary> Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify <i>All</i> as the account ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.EditSSMDocumentPermissionCmdlet.AccountIdsToAdd"> <summary> <para> <para>The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.EditSSMDocumentPermissionCmdlet.AccountIdsToRemove"> <summary> <para> <para>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or <i>All</i>. This action has a higher priority than <c>AccountIdsToAdd</c>. If you specify an ID to add and the same ID to remove, the system removes access to the document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.EditSSMDocumentPermissionCmdlet.Name"> <summary> <para> <para>The name of the document that you want to share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.EditSSMDocumentPermissionCmdlet.PermissionType"> <summary> <para> <para>The permission type for the document. The permission type can be <i>Share</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.EditSSMDocumentPermissionCmdlet.SharedDocumentVersion"> <summary> <para> <para>(Optional) The version of the document to share. If it isn't specified, the system choose the <c>Default</c> version to share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.EditSSMDocumentPermissionCmdlet.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.SimpleSystemsManagement.Model.ModifyDocumentPermissionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.EditSSMDocumentPermissionCmdlet.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.SSM.EditSSMDocumentPermissionCmdlet.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.SSM.GetSSMActivationCmdlet"> <summary> Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.<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.SSM.GetSSMActivationCmdlet.Filter"> <summary> <para> <para>A filter to view information about your activations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMActivationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMActivationCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMActivationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActivationList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeActivationsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeActivationsResponse 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.SSM.GetSSMActivationCmdlet.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.SSM.GetSSMAssociationCmdlet"> <summary> Describes the association for the specified target or managed node. If you created the association by using the <c>Targets</c> parameter, then you must retrieve the association by using the association ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationCmdlet.AssociationId"> <summary> <para> <para>The association ID for which you want information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationCmdlet.AssociationVersion"> <summary> <para> <para>Specify the association version to retrieve. To view the latest version, either specify <c>$LATEST</c> for this parameter, or omit this parameter. To view a list of all associations for a managed node, use <a>ListAssociations</a>. To get a list of versions for a specific association, use <a>ListAssociationVersions</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationCmdlet.InstanceId"> <summary> <para> <para>The managed node ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeAssociationResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeAssociationResponse 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.SSM.GetSSMAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionCmdlet"> <summary> Views all executions for a specific association ID.<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.SSM.GetSSMAssociationExecutionCmdlet.AssociationId"> <summary> <para> <para>The association ID for which you want to view execution history details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionCmdlet.Filter"> <summary> <para> <para>Filters for the request. You can specify the following filters and values.</para><para>ExecutionId (EQUAL)</para><para>Status (EQUAL)</para><para>CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMAssociationExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationExecutions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeAssociationExecutionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeAssociationExecutionsResponse 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.SSM.GetSSMAssociationExecutionCmdlet.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.SSM.GetSSMAssociationExecutionTargetCmdlet"> <summary> Views information about a specific execution of a specific association.<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.SSM.GetSSMAssociationExecutionTargetCmdlet.AssociationId"> <summary> <para> <para>The association ID that includes the execution for which you want to view details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionTargetCmdlet.ExecutionId"> <summary> <para> <para>The execution ID for which you want to view details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionTargetCmdlet.Filter"> <summary> <para> <para>Filters for the request. You can specify the following filters and values.</para><para>Status (EQUAL)</para><para>ResourceId (EQUAL)</para><para>ResourceType (EQUAL)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionTargetCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationExecutionTargetCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMAssociationExecutionTargetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationExecutionTargets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeAssociationExecutionTargetsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeAssociationExecutionTargetsResponse 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.SSM.GetSSMAssociationExecutionTargetCmdlet.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.SSM.GetSSMAssociationListCmdlet"> <summary> Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.<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.SSM.GetSSMAssociationListCmdlet.AssociationFilterList"> <summary> <para> <para>One or more filters. Use a filter to return a more specific list of results.</para><note><para>Filtering associations using the <c>InstanceID</c> attribute only returns legacy associations created using the <c>InstanceID</c> attribute. Associations targeting the managed node that are part of the Target Attributes <c>ResourceGroup</c> or <c>Tags</c> aren't returned.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Associations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListAssociationsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListAssociationsResponse 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.SSM.GetSSMAssociationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationFilterList parameter. The -PassThru parameter is deprecated, use -Select '^AssociationFilterList' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationListCmdlet.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.SSM.GetSSMAssociationVersionListCmdlet"> <summary> Retrieves all versions of an association for a specific association ID.<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.SSM.GetSSMAssociationVersionListCmdlet.AssociationId"> <summary> <para> <para>The association ID for which you want to view all versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationVersionListCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMAssociationVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListAssociationVersionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListAssociationVersionsResponse 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.SSM.GetSSMAssociationVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationVersionListCmdlet.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.SSM.GetSSMAutomationExecutionCmdlet"> <summary> Get detailed information about a particular Automation execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationExecutionCmdlet.AutomationExecutionId"> <summary> <para> <para>The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationExecution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetAutomationExecutionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetAutomationExecutionResponse 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.SSM.GetSSMAutomationExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutomationExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^AutomationExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationExecutionListCmdlet"> <summary> Provides details about all active and terminated Automation executions.<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.SSM.GetSSMAutomationExecutionListCmdlet.Filter"> <summary> <para> <para>Filters used to limit the scope of executions that are requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationExecutionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMAutomationExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationExecutionMetadataList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeAutomationExecutionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeAutomationExecutionsResponse 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.SSM.GetSSMAutomationExecutionListCmdlet.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.SSM.GetSSMAutomationStepExecutionCmdlet"> <summary> Information about all active and terminated step executions in an Automation workflow.<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.SSM.GetSSMAutomationStepExecutionCmdlet.AutomationExecutionId"> <summary> <para> <para>The Automation execution ID for which you want step execution descriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationStepExecutionCmdlet.Filter"> <summary> <para> <para>One or more filters to limit the number of step executions returned by the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationStepExecutionCmdlet.ReverseOrder"> <summary> <para> <para>Indicates whether to list step executions in reverse order by start time. The default value is 'false'.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationStepExecutionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAutomationStepExecutionCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMAutomationStepExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StepExecutions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeAutomationStepExecutionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeAutomationStepExecutionsResponse 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.SSM.GetSSMAutomationStepExecutionCmdlet.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.SSM.GetSSMAvailablePatchCmdlet"> <summary> Lists all patches eligible to be included in a patch baseline. <note><para> Currently, <c>DescribeAvailablePatches</c> supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems. </para></note><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.SSM.GetSSMAvailablePatchCmdlet.Filter"> <summary> <para> <para>Each element in the array is a structure containing a key-value pair.</para><para><b>Windows Server</b></para><para>Supported keys for Windows Server managed node patches include the following:</para><ul><li><para><b><c>PATCH_SET</c></b></para><para>Sample values: <c>OS</c> | <c>APPLICATION</c></para></li><li><para><b><c>PRODUCT</c></b></para><para>Sample values: <c>WindowsServer2012</c> | <c>Office 2010</c> | <c>MicrosoftDefenderAntivirus</c></para></li><li><para><b><c>PRODUCT_FAMILY</c></b></para><para>Sample values: <c>Windows</c> | <c>Office</c></para></li><li><para><b><c>MSRC_SEVERITY</c></b></para><para>Sample values: <c>ServicePacks</c> | <c>Important</c> | <c>Moderate</c></para></li><li><para><b><c>CLASSIFICATION</c></b></para><para>Sample values: <c>ServicePacks</c> | <c>SecurityUpdates</c> | <c>DefinitionUpdates</c></para></li><li><para><b><c>PATCH_ID</c></b></para><para>Sample values: <c>KB123456</c> | <c>KB4516046</c></para></li></ul><para><b>Linux</b></para><important><para>When specifying filters for Linux patches, you must specify a key-pair for <c>PRODUCT</c>. For example, using the Command Line Interface (CLI), the following command fails:</para><para><c>aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615</c></para><para>However, the following command succeeds:</para><para><c>aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615</c></para></important><para>Supported keys for Linux managed node patches include the following:</para><ul><li><para><b><c>PRODUCT</c></b></para><para>Sample values: <c>AmazonLinux2018.03</c> | <c>AmazonLinux2.0</c></para></li><li><para><b><c>NAME</c></b></para><para>Sample values: <c>kernel-headers</c> | <c>samba-python</c> | <c>php</c></para></li><li><para><b><c>SEVERITY</c></b></para><para>Sample values: <c>Critical</c> | <c>Important</c> | <c>Medium</c> | <c>Low</c></para></li><li><para><b><c>EPOCH</c></b></para><para>Sample values: <c>0</c> | <c>1</c></para></li><li><para><b><c>VERSION</c></b></para><para>Sample values: <c>78.6.1</c> | <c>4.10.16</c></para></li><li><para><b><c>RELEASE</c></b></para><para>Sample values: <c>9.56.amzn1</c> | <c>1.amzn2</c></para></li><li><para><b><c>ARCH</c></b></para><para>Sample values: <c>i686</c> | <c>x86_64</c></para></li><li><para><b><c>REPOSITORY</c></b></para><para>Sample values: <c>Core</c> | <c>Updates</c></para></li><li><para><b><c>ADVISORY_ID</c></b></para><para>Sample values: <c>ALAS-2018-1058</c> | <c>ALAS2-2021-1594</c></para></li><li><para><b><c>CVE_ID</c></b></para><para>Sample values: <c>CVE-2018-3615</c> | <c>CVE-2020-1472</c></para></li><li><para><b><c>BUGZILLA_ID</c></b></para><para>Sample values: <c>1463241</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAvailablePatchCmdlet.MaxResult"> <summary> <para> <para>The maximum number of patches to return (per page).</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAvailablePatchCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMAvailablePatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Patches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeAvailablePatchesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeAvailablePatchesResponse 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.SSM.GetSSMAvailablePatchCmdlet.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.SSM.GetSSMCalendarStateCmdlet"> <summary> Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, <c>GetCalendarState</c> returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, <c>GetCalendarState</c> uses the current time. Change Calendar entries have two possible states: <c>OPEN</c> or <c>CLOSED</c>. <para> If you specify more than one calendar in a request, the command returns the status of <c>OPEN</c> only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is <c>CLOSED</c>. </para><para> For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html">Amazon Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCalendarStateCmdlet.AtTime"> <summary> <para> <para>(Optional) The specific time for which you want to get calendar state information, in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format. If you don't specify a value or <c>AtTime</c>, the current time is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCalendarStateCmdlet.CalendarName"> <summary> <para> <para>The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCalendarStateCmdlet.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.SimpleSystemsManagement.Model.GetCalendarStateResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetCalendarStateResponse 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.SSM.GetSSMCalendarStateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AtTime parameter. The -PassThru parameter is deprecated, use -Select '^AtTime' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet"> <summary> Lists the commands requested by users of the Amazon Web Services account.<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.SSM.GetSSMCommandCmdlet.CommandId"> <summary> <para> <para>(Optional) If provided, lists only the specified command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.Filter"> <summary> <para> <para>(Optional) One or more filters. Use a filter to return a more specific list of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.InstanceId"> <summary> <para> <para>(Optional) Lists commands issued against this managed node ID.</para><note><para>You can't specify a managed node ID in the same command that you specify <c>Status</c> = <c>Pending</c>. This is because the command hasn't reached the managed node yet.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.MaxResult"> <summary> <para> <para>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.NextToken"> <summary> <para> <para>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMCommandCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Commands'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListCommandsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListCommandsResponse 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.SSM.GetSSMCommandCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.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.SSM.GetSSMCommandInvocationCmdlet"> <summary> An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs <c>SendCommand</c> against three managed nodes, then a command invocation is created for each requested managed node ID. <c>ListCommandInvocations</c> provide status about command execution.<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.SSM.GetSSMCommandInvocationCmdlet.CommandId"> <summary> <para> <para>(Optional) The invocations for a specific command ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.Detail"> <summary> <para> <para>(Optional) If set this returns the response of the command executions and any command output. The default value is <c>false</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.Filter"> <summary> <para> <para>(Optional) One or more filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.InstanceId"> <summary> <para> <para>(Optional) The command execution details for a specific managed node ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.MaxResult"> <summary> <para> <para>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.NextToken"> <summary> <para> <para>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMCommandInvocationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CommandInvocations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListCommandInvocationsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListCommandInvocationsResponse 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.SSM.GetSSMCommandInvocationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.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.SSM.GetSSMCommandInvocationDetailCmdlet"> <summary> Returns detailed information about command execution for an invocation or plugin. <para><c>GetCommandInvocation</c> only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use <a>ListCommandInvocations</a>. To get the command execution status across managed nodes, use <a>ListCommands</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationDetailCmdlet.CommandId"> <summary> <para> <para>(Required) The parent command ID of the invocation plugin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationDetailCmdlet.InstanceId"> <summary> <para> <para>(Required) The ID of the managed node targeted by the command. A <i>managed node</i> can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationDetailCmdlet.PluginName"> <summary> <para> <para>The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like <c>aws:RunShellScript</c>.</para><para>To find the <c>PluginName</c>, check the document content and find the name of the step you want details for. Alternatively, use <a>ListCommandInvocations</a> with the <c>CommandId</c> and <c>Details</c> parameters. The <c>PluginName</c> is the <c>Name</c> attribute of the <c>CommandPlugin</c> object in the <c>CommandPlugins</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationDetailCmdlet.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.SimpleSystemsManagement.Model.GetCommandInvocationResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetCommandInvocationResponse 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.SSM.GetSSMCommandInvocationDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMComplianceItemListCmdlet"> <summary> For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.<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.SSM.GetSSMComplianceItemListCmdlet.Filter"> <summary> <para> <para>One or more compliance filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMComplianceItemListCmdlet.ResourceId"> <summary> <para> <para>The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMComplianceItemListCmdlet.ResourceType"> <summary> <para> <para>The type of resource from which to get compliance information. Currently, the only supported resource type is <c>ManagedInstance</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMComplianceItemListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMComplianceItemListCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMComplianceItemListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComplianceItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListComplianceItemsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListComplianceItemsResponse 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.SSM.GetSSMComplianceItemListCmdlet.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.SSM.GetSSMComplianceSummaryListCmdlet"> <summary> Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.<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.SSM.GetSSMComplianceSummaryListCmdlet.Filter"> <summary> <para> <para>One or more compliance or inventory filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMComplianceSummaryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMComplianceSummaryListCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMComplianceSummaryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComplianceSummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListComplianceSummariesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListComplianceSummariesResponse 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.SSM.GetSSMComplianceSummaryListCmdlet.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.SSM.GetSSMConnectionStatusCmdlet"> <summary> Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMConnectionStatusCmdlet.Target"> <summary> <para> <para>The managed node ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMConnectionStatusCmdlet.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.SimpleSystemsManagement.Model.GetConnectionStatusResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetConnectionStatusResponse 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.SSM.GetSSMConnectionStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Target parameter. The -PassThru parameter is deprecated, use -Select '^Target' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMDefaultPatchBaselineCmdlet"> <summary> Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. <para> If you don't specify an operating system value, the default patch baseline for Windows is returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDefaultPatchBaselineCmdlet.OperatingSystem"> <summary> <para> <para>Returns the default patch baseline for the specified operating system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDefaultPatchBaselineCmdlet.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.SimpleSystemsManagement.Model.GetDefaultPatchBaselineResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetDefaultPatchBaselineResponse 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.SSM.GetSSMDefaultPatchBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OperatingSystem parameter. The -PassThru parameter is deprecated, use -Select '^OperatingSystem' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet"> <summary> Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the <c>AWS-RunPatchBaseline</c> Systems Manager document (SSM document). <note><para> If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the <c>AWS-RunShellScript</c> document or the <c>AWS-RunPowerShellScript</c> document. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.BaselineOverride_ApprovedPatch"> <summary> <para> <para>A list of explicitly approved patches for the baseline.</para><para>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.BaselineOverride_ApprovedPatchesComplianceLevel"> <summary> <para> <para>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.BaselineOverride_ApprovedPatchesEnableNonSecurity"> <summary> <para> <para>Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is <c>false</c>. Applies to Linux managed nodes only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.InstanceId"> <summary> <para> <para>The ID of the managed node for which the appropriate patch snapshot should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.BaselineOverride_OperatingSystem"> <summary> <para> <para>The operating system rule used by the patch baseline override.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.GlobalFilters_PatchFilter"> <summary> <para> <para>The set of patch filters that make up the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.ApprovalRules_PatchRule"> <summary> <para> <para>The rules that make up the rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.BaselineOverride_RejectedPatch"> <summary> <para> <para>A list of explicitly rejected patches for the baseline.</para><para>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.BaselineOverride_RejectedPatchesAction"> <summary> <para> <para>The action for Patch Manager to take on patches included in the <c>RejectedPackages</c> list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.SnapshotId"> <summary> <para> <para>The snapshot ID provided by the user when running <c>AWS-RunPatchBaseline</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.BaselineOverride_Source"> <summary> <para> <para>Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.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.SimpleSystemsManagement.Model.GetDeployablePatchSnapshotForInstanceResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetDeployablePatchSnapshotForInstanceResponse 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.SSM.GetSSMDeployablePatchSnapshotForInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet"> <summary> Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet.DocumentFormat"> <summary> <para> <para>Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet.DocumentVersion"> <summary> <para> <para>The document version for which you want information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet.VersionName"> <summary> <para> <para>An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can't be changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet.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.SimpleSystemsManagement.Model.GetDocumentResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetDocumentResponse 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.SSM.GetSSMDocumentDescriptionCmdlet"> <summary> Describes the specified Amazon Web Services Systems Manager document (SSM document). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentDescriptionCmdlet.DocumentVersion"> <summary> <para> <para>The document version for which you want information. Can be a specific version or the default version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentDescriptionCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentDescriptionCmdlet.VersionName"> <summary> <para> <para>An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentDescriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Document'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeDocumentResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeDocumentResponse 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.SSM.GetSSMDocumentListCmdlet"> <summary> Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.<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.SSM.GetSSMDocumentListCmdlet.DocumentFilterList"> <summary> <para> <para>This data type is deprecated. Instead, use <c>Filters</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentListCmdlet.Filter"> <summary> <para> <para>One or more <c>DocumentKeyValuesFilter</c> objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include <c>Owner</c>, <c>Name</c>, <c>PlatformTypes</c>, <c>DocumentType</c>, and <c>TargetType</c>. For example, to return documents you own use <c>Key=Owner,Values=Self</c>. To specify a custom key-value pair, use the format <c>Key=tag:tagName,Values=valueName</c>.</para><note><para>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <c>Key=tag:tagName,Values=valueName1,valueName2</c></para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMDocumentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentIdentifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListDocumentsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListDocumentsResponse 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.SSM.GetSSMDocumentListCmdlet.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.SSM.GetSSMDocumentMetadataHistoryCmdlet"> <summary> Information about approval reviews for a version of a change template in Change Manager.<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.SSM.GetSSMDocumentMetadataHistoryCmdlet.DocumentVersion"> <summary> <para> <para>The version of the change template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentMetadataHistoryCmdlet.Metadata"> <summary> <para> <para>The type of data for which details are being requested. Currently, the only supported value is <c>DocumentReviews</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentMetadataHistoryCmdlet.Name"> <summary> <para> <para>The name of the change template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentMetadataHistoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentMetadataHistoryCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMDocumentMetadataHistoryCmdlet.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.SimpleSystemsManagement.Model.ListDocumentMetadataHistoryResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListDocumentMetadataHistoryResponse 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.SSM.GetSSMDocumentMetadataHistoryCmdlet.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.SSM.GetSSMDocumentPermissionCmdlet"> <summary> Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (<i>All</i>).<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.SSM.GetSSMDocumentPermissionCmdlet.Name"> <summary> <para> <para>The name of the document for which you are the owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentPermissionCmdlet.PermissionType"> <summary> <para> <para>The permission type for the document. The permission type can be <i>Share</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentPermissionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentPermissionCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMDocumentPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeDocumentPermissionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeDocumentPermissionResponse 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.SSM.GetSSMDocumentPermissionCmdlet.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.SSM.GetSSMDocumentPermissionCmdlet.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.SSM.GetSSMDocumentVersionListCmdlet"> <summary> List all versions for a document.<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.SSM.GetSSMDocumentVersionListCmdlet.Name"> <summary> <para> <para>The name of the document. You can specify an Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentVersionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMDocumentVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListDocumentVersionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListDocumentVersionsResponse 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.SSM.GetSSMDocumentVersionListCmdlet.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.SSM.GetSSMDocumentVersionListCmdlet.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.SSM.GetSSMEffectiveInstanceAssociationListCmdlet"> <summary> All associations for the managed nodes.<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.SSM.GetSSMEffectiveInstanceAssociationListCmdlet.InstanceId"> <summary> <para> <para>The managed node ID for which you want to view all associations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMEffectiveInstanceAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>5</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMEffectiveInstanceAssociationListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMEffectiveInstanceAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Associations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeEffectiveInstanceAssociationsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeEffectiveInstanceAssociationsResponse 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.SSM.GetSSMEffectiveInstanceAssociationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMEffectiveInstanceAssociationListCmdlet.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.SSM.GetSSMEffectivePatchesForPatchBaselineCmdlet"> <summary> Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.<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.SSM.GetSSMEffectivePatchesForPatchBaselineCmdlet.BaselineId"> <summary> <para> <para>The ID of the patch baseline to retrieve the effective patches for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMEffectivePatchesForPatchBaselineCmdlet.MaxResult"> <summary> <para> <para>The maximum number of patches to return (per page).</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMEffectivePatchesForPatchBaselineCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMEffectivePatchesForPatchBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EffectivePatches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeEffectivePatchesForPatchBaselineResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeEffectivePatchesForPatchBaselineResponse 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.SSM.GetSSMEffectivePatchesForPatchBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BaselineId parameter. The -PassThru parameter is deprecated, use -Select '^BaselineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMEffectivePatchesForPatchBaselineCmdlet.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.SSM.GetSSMInstanceAssociationsStatusCmdlet"> <summary> The status of the associations for the managed nodes.<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.SSM.GetSSMInstanceAssociationsStatusCmdlet.InstanceId"> <summary> <para> <para>The managed node IDs for which you want association status information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceAssociationsStatusCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceAssociationsStatusCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMInstanceAssociationsStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstanceAssociationStatusInfos'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeInstanceAssociationsStatusResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeInstanceAssociationsStatusResponse 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.SSM.GetSSMInstanceAssociationsStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceAssociationsStatusCmdlet.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.SSM.GetSSMInstanceInformationCmdlet"> <summary> Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated. <para> If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error. </para><note><para> The <c>IamRole</c> field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances. </para></note><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.SSM.GetSSMInstanceInformationCmdlet.Filter"> <summary> <para> <para>One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be combined with other filter types. Use this <c>Filters</c> data type instead of <c>InstanceInformationFilterList</c>, which is deprecated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceInformationCmdlet.InstanceInformationFilterList"> <summary> <para> <para>This is a legacy method. We recommend that you don't use this method. Instead, use the <c>Filters</c> data type. <c>Filters</c> enables you to return node information by filtering based on tags applied to managed nodes.</para><note><para>Attempting to use <c>InstanceInformationFilterList</c> and <c>Filters</c> leads to an exception error. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceInformationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. The default value is 10 items. </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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceInformationCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMInstanceInformationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstanceInformationList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeInstanceInformationResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeInstanceInformationResponse 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.SSM.GetSSMInstanceInformationCmdlet.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.SSM.GetSSMInstancePatchCmdlet"> <summary> Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.<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.SSM.GetSSMInstancePatchCmdlet.Filter"> <summary> <para> <para>Each element in the array is a structure containing a key-value pair.</para><para>Supported keys for <c>DescribeInstancePatches</c>include the following:</para><ul><li><para><b><c>Classification</c></b></para><para>Sample values: <c>Security</c> | <c>SecurityUpdates</c></para></li><li><para><b><c>KBId</c></b></para><para>Sample values: <c>KB4480056</c> | <c>java-1.7.0-openjdk.x86_64</c></para></li><li><para><b><c>Severity</c></b></para><para>Sample values: <c>Important</c> | <c>Medium</c> | <c>Low</c></para></li><li><para><b><c>State</c></b></para><para>Sample values: <c>Installed</c> | <c>InstalledOther</c> | <c>InstalledPendingReboot</c></para><para>For lists of all <c>State</c> values, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-compliance-states.html">Understanding patch compliance state values</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchCmdlet.InstanceId"> <summary> <para> <para>The ID of the managed node whose patch state information should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchCmdlet.MaxResult"> <summary> <para> <para>The maximum number of patches to return (per page).</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMInstancePatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Patches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchesResponse 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.SSM.GetSSMInstancePatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchCmdlet.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.SSM.GetSSMInstancePatchStateCmdlet"> <summary> Retrieves the high-level patch state of one or more managed nodes.<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.SSM.GetSSMInstancePatchStateCmdlet.InstanceId"> <summary> <para> <para>The ID of the managed node for which patch state information should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchStateCmdlet.MaxResult"> <summary> <para> <para>The maximum number of managed nodes to return (per page).</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchStateCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMInstancePatchStateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstancePatchStates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchStatesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchStatesResponse 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.SSM.GetSSMInstancePatchStateCmdlet.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.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet"> <summary> Retrieves the high-level patch state for the managed nodes in the specified patch group.<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.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet.Filter"> <summary> <para> <para>Each entry in the array is a structure containing:</para><ul><li><para>Key (string between 1 and 200 characters)</para></li><li><para>Values (array containing a single string)</para></li><li><para>Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet.PatchGroup"> <summary> <para> <para>The name of the patch group for which the patch state information should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet.MaxResult"> <summary> <para> <para>The maximum number of patches to return (per page).</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstancePatchStates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchStatesForPatchGroupResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchStatesForPatchGroupResponse 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.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PatchGroup parameter. The -PassThru parameter is deprecated, use -Select '^PatchGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePatchStatesForPatchGroupCmdlet.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.SSM.GetSSMInstancePropertyCmdlet"> <summary> An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.<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.SSM.GetSSMInstancePropertyCmdlet.FiltersWithOperator"> <summary> <para> <para>The request filters to use with the operator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePropertyCmdlet.InstancePropertyFilterList"> <summary> <para> <para>An array of instance property filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePropertyCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for the call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstancePropertyCmdlet.NextToken"> <summary> <para> <para>The token provided by a previous request to use to return the next set of properties.</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.SSM.GetSSMInstancePropertyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstanceProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeInstancePropertiesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeInstancePropertiesResponse 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.SSM.GetSSMInstancePropertyCmdlet.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.SSM.GetSSMInventoryCmdlet"> <summary> Query inventory information. This includes managed node status, such as <c>Stopped</c> or <c>Terminated</c>.<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.SSM.GetSSMInventoryCmdlet.Aggregator"> <summary> <para> <para>Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the <c>AWS:InstanceInformation.PlatformType</c> type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryCmdlet.Filter"> <summary> <para> <para>One or more filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryCmdlet.ResultAttribute"> <summary> <para> <para>The list of inventory item types to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMInventoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetInventoryResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetInventoryResponse 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.SSM.GetSSMInventoryCmdlet.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.SSM.GetSSMInventoryDeletionListCmdlet"> <summary> Describes a specific delete inventory operation.<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.SSM.GetSSMInventoryDeletionListCmdlet.DeletionId"> <summary> <para> <para>Specify the delete inventory ID for which you want information. This ID was returned by the <c>DeleteInventory</c> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryDeletionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryDeletionListCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMInventoryDeletionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InventoryDeletions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeInventoryDeletionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeInventoryDeletionsResponse 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.SSM.GetSSMInventoryDeletionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeletionId parameter. The -PassThru parameter is deprecated, use -Select '^DeletionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryDeletionListCmdlet.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.SSM.GetSSMInventoryEntryListCmdlet"> <summary> A list of inventory items returned by the request.<br/><br/>In the AWS.Tools.SimpleSystemsManagement 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.SSM.GetSSMInventoryEntryListCmdlet.Filter"> <summary> <para> <para>One or more filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryEntryListCmdlet.InstanceId"> <summary> <para> <para>The managed node ID for which you want inventory information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryEntryListCmdlet.TypeName"> <summary> <para> <para>The type of inventory item for which you want information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryEntryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryEntryListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.SimpleSystemsManagement 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.SSM.GetSSMInventoryEntryListCmdlet.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.SimpleSystemsManagement.Model.ListInventoryEntriesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListInventoryEntriesResponse 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.SSM.GetSSMInventoryEntryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventoryEntryListCmdlet.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.SSM.GetSSMInventorySchemaCmdlet"> <summary> Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.<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.SSM.GetSSMInventorySchemaCmdlet.Aggregator"> <summary> <para> <para>Returns inventory schemas that support aggregation. For example, this call returns the <c>AWS:InstanceInformation</c> type, because it supports aggregation based on the <c>PlatformName</c>, <c>PlatformType</c>, and <c>PlatformVersion</c> attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventorySchemaCmdlet.SubType"> <summary> <para> <para>Returns the sub-type schema for a specified inventory type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventorySchemaCmdlet.TypeName"> <summary> <para> <para>The type of inventory item to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventorySchemaCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>200</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventorySchemaCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMInventorySchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schemas'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetInventorySchemaResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetInventorySchemaResponse 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.SSM.GetSSMInventorySchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TypeName parameter. The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInventorySchemaCmdlet.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.SSM.GetSSMMaintenanceWindowCmdlet"> <summary> Retrieves a maintenance window. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window for which you want to retrieve information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowCmdlet.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.SimpleSystemsManagement.Model.GetMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowResponse 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.SSM.GetSSMMaintenanceWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowId parameter. The -PassThru parameter is deprecated, use -Select '^WindowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionCmdlet"> <summary> Retrieves details about a specific a maintenance window execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionCmdlet.WindowExecutionId"> <summary> <para> <para>The ID of the maintenance window execution that includes the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionCmdlet.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.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionResponse 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.SSM.GetSSMMaintenanceWindowExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^WindowExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionListCmdlet"> <summary> Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.<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.SSM.GetSSMMaintenanceWindowExecutionListCmdlet.Filter"> <summary> <para> <para>Each entry in the array is a structure containing:</para><ul><li><para>Key. A string between 1 and 128 characters. Supported keys include <c>ExecutedBefore</c> and <c>ExecutedAfter</c>.</para></li><li><para>Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as <c>2021-11-04T05:00:00Z</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionListCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window whose executions should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowExecutions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionsResponse 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.SSM.GetSSMMaintenanceWindowExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowId parameter. The -PassThru parameter is deprecated, use -Select '^WindowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionListCmdlet.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.SSM.GetSSMMaintenanceWindowExecutionTaskCmdlet"> <summary> Retrieves the details about a specific task run as part of a maintenance window execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskCmdlet.TaskId"> <summary> <para> <para>The ID of the specific task execution in the maintenance window task that should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskCmdlet.WindowExecutionId"> <summary> <para> <para>The ID of the maintenance window execution that includes the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskCmdlet.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.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskResponse 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.SSM.GetSSMMaintenanceWindowExecutionTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationCmdlet"> <summary> Retrieves information about a specific task running on a specific target. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationCmdlet.InvocationId"> <summary> <para> <para>The invocation ID to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationCmdlet.TaskId"> <summary> <para> <para>The ID of the specific task in the maintenance window task that should be retrieved. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationCmdlet.WindowExecutionId"> <summary> <para> <para>The ID of the maintenance window execution for which the task is a part.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationCmdlet.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.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskInvocationResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskInvocationResponse 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.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet"> <summary> Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.<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.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.Filter"> <summary> <para> <para>Optional filters used to scope down the returned task invocations. The supported filter key is <c>STATUS</c> with the corresponding values <c>PENDING</c>, <c>IN_PROGRESS</c>, <c>SUCCESS</c>, <c>FAILED</c>, <c>TIMED_OUT</c>, <c>CANCELLING</c>, and <c>CANCELLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.TaskId"> <summary> <para> <para>The ID of the specific task in the maintenance window task that should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.WindowExecutionId"> <summary> <para> <para>The ID of the maintenance window execution the task is part of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowExecutionTaskInvocationIdentities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse 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.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^WindowExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskInvocationListCmdlet.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.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet"> <summary> For a given maintenance window execution, lists the tasks that were run.<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.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet.Filter"> <summary> <para> <para>Optional filters used to scope down the returned tasks. The supported filter key is <c>STATUS</c> with the corresponding values <c>PENDING</c>, <c>IN_PROGRESS</c>, <c>SUCCESS</c>, <c>FAILED</c>, <c>TIMED_OUT</c>, <c>CANCELLING</c>, and <c>CANCELLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet.WindowExecutionId"> <summary> <para> <para>The ID of the maintenance window execution whose task executions should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowExecutionTaskIdentities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionTasksResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionTasksResponse 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.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^WindowExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowExecutionTaskListCmdlet.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.SSM.GetSSMMaintenanceWindowListCmdlet"> <summary> Retrieves the maintenance windows in an Amazon Web Services account.<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.SSM.GetSSMMaintenanceWindowListCmdlet.Filter"> <summary> <para> <para>Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are <c>Name</c> and <c>Enabled</c>. For example, <c>Name=MyMaintenanceWindow</c> and <c>Enabled=True</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowIdentities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowsResponse 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.SSM.GetSSMMaintenanceWindowListCmdlet.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.SSM.GetSSMMaintenanceWindowListCmdlet.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.SSM.GetSSMMaintenanceWindowScheduleCmdlet"> <summary> Retrieves information about upcoming executions of a maintenance window.<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.SSM.GetSSMMaintenanceWindowScheduleCmdlet.Filter"> <summary> <para> <para>Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowScheduleCmdlet.ResourceType"> <summary> <para> <para>The type of resource you want to retrieve information about. For example, <c>INSTANCE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowScheduleCmdlet.Target"> <summary> <para> <para>The managed node ID or key-value pair to retrieve information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowScheduleCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window to retrieve information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowScheduleCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowScheduleCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScheduledWindowExecutions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowScheduleResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowScheduleResponse 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.SSM.GetSSMMaintenanceWindowScheduleCmdlet.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.SSM.GetSSMMaintenanceWindowsForTargetCmdlet"> <summary> Retrieves information about the maintenance window targets or tasks that a managed node is associated with.<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.SSM.GetSSMMaintenanceWindowsForTargetCmdlet.ResourceType"> <summary> <para> <para>The type of resource you want to retrieve information about. For example, <c>INSTANCE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowsForTargetCmdlet.Target"> <summary> <para> <para>The managed node ID or key-value pair to retrieve information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowsForTargetCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowsForTargetCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowsForTargetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowIdentities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowsForTargetResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowsForTargetResponse 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.SSM.GetSSMMaintenanceWindowsForTargetCmdlet.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.SSM.GetSSMMaintenanceWindowTargetCmdlet"> <summary> Lists the targets registered with the maintenance window.<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.SSM.GetSSMMaintenanceWindowTargetCmdlet.Filter"> <summary> <para> <para>Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are <c>Type</c>, <c>WindowTargetId</c>, and <c>OwnerInformation</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTargetCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window whose targets should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTargetCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTargetCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowTargetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Targets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowTargetsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowTargetsResponse 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.SSM.GetSSMMaintenanceWindowTargetCmdlet.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.SSM.GetSSMMaintenanceWindowTaskCmdlet"> <summary> Retrieves the details of a maintenance window task. <note><para> For maintenance window tasks without a specified target, you can't supply values for <c>--max-errors</c> and <c>--max-concurrency</c>. Instead, the system inserts a placeholder value of <c>1</c>, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored. </para></note><para> To retrieve a list of tasks in a maintenance window, instead use the <a>DescribeMaintenanceWindowTasks</a> command. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskCmdlet.WindowId"> <summary> <para> <para>The maintenance window ID that includes the task to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskCmdlet.WindowTaskId"> <summary> <para> <para>The maintenance window task ID to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskCmdlet.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.SimpleSystemsManagement.Model.GetMaintenanceWindowTaskResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowTaskResponse 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.SSM.GetSSMMaintenanceWindowTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowTaskId parameter. The -PassThru parameter is deprecated, use -Select '^WindowTaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskListCmdlet"> <summary> Lists the tasks in a maintenance window. <note><para> For maintenance window tasks without a specified target, you can't supply values for <c>--max-errors</c> and <c>--max-concurrency</c>. Instead, the system inserts a placeholder value of <c>1</c>, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored. </para></note><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.SSM.GetSSMMaintenanceWindowTaskListCmdlet.Filter"> <summary> <para> <para>Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are <c>WindowTaskId</c>, <c>TaskArn</c>, <c>Priority</c>, and <c>TaskType</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskListCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window whose tasks should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMMaintenanceWindowTaskListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowTasksResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowTasksResponse 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.SSM.GetSSMMaintenanceWindowTaskListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowId parameter. The -PassThru parameter is deprecated, use -Select '^WindowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMMaintenanceWindowTaskListCmdlet.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.SSM.GetSSMOpsItemCmdlet"> <summary> Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. <para> Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemCmdlet.OpsItemArn"> <summary> <para> <para>The OpsItem Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemCmdlet.OpsItemId"> <summary> <para> <para>The ID of the OpsItem that you want to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OpsItem'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetOpsItemResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetOpsItemResponse 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.SSM.GetSSMOpsItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsItemId parameter. The -PassThru parameter is deprecated, use -Select '^OpsItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemEventCmdlet"> <summary> Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.<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.SSM.GetSSMOpsItemEventCmdlet.Filter"> <summary> <para> <para>One or more OpsItem filters. Use a filter to return a more specific list of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemEventCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemEventCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMOpsItemEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListOpsItemEventsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListOpsItemEventsResponse 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.SSM.GetSSMOpsItemEventCmdlet.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.SSM.GetSSMOpsItemRelatedItemCmdlet"> <summary> Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.<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.SSM.GetSSMOpsItemRelatedItemCmdlet.Filter"> <summary> <para> <para>One or more OpsItem filters. Use a filter to return a more specific list of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemRelatedItemCmdlet.OpsItemId"> <summary> <para> <para>The ID of the OpsItem for which you want to list all related-item resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemRelatedItemCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemRelatedItemCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMOpsItemRelatedItemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListOpsItemRelatedItemsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListOpsItemRelatedItemsResponse 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.SSM.GetSSMOpsItemRelatedItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsItemId parameter. The -PassThru parameter is deprecated, use -Select '^OpsItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemRelatedItemCmdlet.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.SSM.GetSSMOpsItemSummaryCmdlet"> <summary> Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. <para> Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </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.SSM.GetSSMOpsItemSummaryCmdlet.OpsItemFilter"> <summary> <para> <para>One or more filters to limit the response.</para><ul><li><para>Key: CreatedTime</para><para>Operations: GreaterThan, LessThan</para></li><li><para>Key: LastModifiedBy</para><para>Operations: Contains, Equals</para></li><li><para>Key: LastModifiedTime</para><para>Operations: GreaterThan, LessThan</para></li><li><para>Key: Priority</para><para>Operations: Equals</para></li><li><para>Key: Source</para><para>Operations: Contains, Equals</para></li><li><para>Key: Status</para><para>Operations: Equals</para></li><li><para>Key: Title*</para><para>Operations: Equals,Contains</para></li><li><para>Key: OperationalData**</para><para>Operations: Equals</para></li><li><para>Key: OperationalDataKey</para><para>Operations: Equals</para></li><li><para>Key: OperationalDataValue</para><para>Operations: Equals, Contains</para></li><li><para>Key: OpsItemId</para><para>Operations: Equals</para></li><li><para>Key: ResourceId</para><para>Operations: Contains</para></li><li><para>Key: AutomationId</para><para>Operations: Equals</para></li><li><para>Key: AccountId</para><para>Operations: Equals</para></li></ul><para>*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.</para><para>**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemSummaryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemSummaryCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results.</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.SSM.GetSSMOpsItemSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OpsItemSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeOpsItemsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeOpsItemsResponse 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.SSM.GetSSMOpsItemSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsItemFilter parameter. The -PassThru parameter is deprecated, use -Select '^OpsItemFilter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsItemSummaryCmdlet.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.SSM.GetSSMOpsMetadataCmdlet"> <summary> View operational metadata related to an application in Application Manager.<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.SSM.GetSSMOpsMetadataCmdlet.OpsMetadataArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an OpsMetadata Object to view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsMetadataCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsMetadataCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results.</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.SSM.GetSSMOpsMetadataCmdlet.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.SimpleSystemsManagement.Model.GetOpsMetadataResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetOpsMetadataResponse 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.SSM.GetSSMOpsMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsMetadataArn parameter. The -PassThru parameter is deprecated, use -Select '^OpsMetadataArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsMetadataCmdlet.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.SSM.GetSSMOpsMetadataListCmdlet"> <summary> Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.<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.SSM.GetSSMOpsMetadataListCmdlet.Filter"> <summary> <para> <para>One or more filters to limit the number of OpsMetadata objects returned by the call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsMetadataListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsMetadataListCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results.</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.SSM.GetSSMOpsMetadataListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OpsMetadataList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListOpsMetadataResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListOpsMetadataResponse 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.SSM.GetSSMOpsMetadataListCmdlet.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.SSM.GetSSMOpsSummaryCmdlet"> <summary> View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.<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.SSM.GetSSMOpsSummaryCmdlet.Aggregator"> <summary> <para> <para>Optional aggregators that return counts of OpsData based on one or more expressions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsSummaryCmdlet.Filter"> <summary> <para> <para>Optional filters used to scope down the returned OpsData. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsSummaryCmdlet.ResultAttribute"> <summary> <para> <para>The OpsData data type to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsSummaryCmdlet.SyncName"> <summary> <para> <para>Specify the name of a resource data sync to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsSummaryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsSummaryCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMOpsSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetOpsSummaryResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetOpsSummaryResponse 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.SSM.GetSSMOpsSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Aggregator parameter. The -PassThru parameter is deprecated, use -Select '^Aggregator' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMOpsSummaryCmdlet.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.SSM.GetSSMParameterCmdlet"> <summary> Get information about a single parameter by specifying the parameter name. <note><para> To get information about more than one parameter at a time, use the <a>GetParameters</a> operation. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterCmdlet.Name"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.</para><para>To query by parameter label, use <c>"Name": "name:label"</c>. To query by parameter version, use <c>"Name": "name:version"</c>.</para><para>For more information about shared parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sharing.html">Working with shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterCmdlet.WithDecryption"> <summary> <para> <para>Return decrypted values for secure string parameters. This flag is ignored for <c>String</c> and <c>StringList</c> parameter types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Parameter'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetParameterResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetParameterResponse 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.SSM.GetSSMParameterCmdlet.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="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterHistoryCmdlet"> <summary> Retrieves the history of all changes to a parameter. <important><para> If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, <c>GetParameterHistory</c> retrieves whatever the original key alias was referencing. </para></important><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.SSM.GetSSMParameterHistoryCmdlet.Name"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterHistoryCmdlet.WithDecryption"> <summary> <para> <para>Return decrypted values for secure string parameters. This flag is ignored for <c>String</c> and <c>StringList</c> parameter types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterHistoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterHistoryCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMParameterHistoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Parameters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetParameterHistoryResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetParameterHistoryResponse 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.SSM.GetSSMParameterHistoryCmdlet.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.SSM.GetSSMParameterHistoryCmdlet.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.SSM.GetSSMParameterListCmdlet"> <summary> Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the <a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html#systemsmanager-DescribeParameters-request-Shared">Shared</a> option. <para> Request results are returned on a best-effort basis. If you specify <c>MaxResults</c> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <c>MaxResults</c>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <c>NextToken</c>. You can specify the <c>NextToken</c> in a subsequent call to get the next set of results. </para><important><para> If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, <c>DescribeParameters</c> retrieves whatever the original key alias was referencing. </para></important><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.SSM.GetSSMParameterListCmdlet.Filter"> <summary> <para> <para>This data type is deprecated. Instead, use <c>ParameterFilters</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterListCmdlet.ParameterFilter"> <summary> <para> <para>Filters to limit the request results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterListCmdlet.Shared"> <summary> <para> <para>Lists parameters that are shared with you.</para><note><para>By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the <a>PutResourcePolicy</a> command to be returned, the associated <c>RAM Resource Share Created From Policy</c> must have been promoted to a standard Resource Share using the RAM <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> API operation.</para><para>For more information about sharing parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMParameterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Parameters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeParametersResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeParametersResponse 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.SSM.GetSSMParameterListCmdlet.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.SSM.GetSSMParameterValueCmdlet"> <summary> Get information about one or more parameters by specifying multiple parameter names. <note><para> To get information about a single parameter, you can use the <a>GetParameter</a> operation instead. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterValueCmdlet.Name"> <summary> <para> <para>The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.</para><para>To query by parameter label, use <c>"Name": "name:label"</c>. To query by parameter version, use <c>"Name": "name:version"</c>.</para><note><para>The results for <c>GetParameters</c> requests are listed in alphabetical order in query responses.</para></note><para>For information about shared parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterValueCmdlet.WithDecryption"> <summary> <para> <para>Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for <c>String</c> and <c>StringList</c> parameter types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMParameterValueCmdlet.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.SimpleSystemsManagement.Model.GetParametersResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetParametersResponse 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.SSM.GetSSMPatchBaselineCmdlet"> <summary> Lists the patch baselines in your Amazon Web Services account.<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.SSM.GetSSMPatchBaselineCmdlet.Filter"> <summary> <para> <para>Each element in the array is a structure containing a key-value pair.</para><para>Supported keys for <c>DescribePatchBaselines</c> include the following:</para><ul><li><para><b><c>NAME_PREFIX</c></b></para><para>Sample values: <c>AWS-</c> | <c>My-</c></para></li><li><para><b><c>OWNER</c></b></para><para>Sample values: <c>AWS</c> | <c>Self</c></para></li><li><para><b><c>OPERATING_SYSTEM</c></b></para><para>Sample values: <c>AMAZON_LINUX</c> | <c>SUSE</c> | <c>WINDOWS</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineCmdlet.MaxResult"> <summary> <para> <para>The maximum number of patch baselines to return (per page).</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMPatchBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaselineIdentities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribePatchBaselinesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribePatchBaselinesResponse 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.SSM.GetSSMPatchBaselineCmdlet.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.SSM.GetSSMPatchBaselineDetailCmdlet"> <summary> Retrieves information about a patch baseline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineDetailCmdlet.BaselineId"> <summary> <para> <para>The ID of the patch baseline to retrieve.</para><note><para>To retrieve information about an Amazon Web Services managed patch baseline, specify the full Amazon Resource Name (ARN) of the baseline. For example, for the baseline <c>AWS-AmazonLinuxDefaultPatchBaseline</c>, specify <c>arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7</c> instead of <c>pb-0e392de35e7c563b7</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineDetailCmdlet.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.SimpleSystemsManagement.Model.GetPatchBaselineResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetPatchBaselineResponse 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.SSM.GetSSMPatchBaselineDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BaselineId parameter. The -PassThru parameter is deprecated, use -Select '^BaselineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineForPatchGroupCmdlet"> <summary> Retrieves the patch baseline that should be used for the specified patch group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineForPatchGroupCmdlet.OperatingSystem"> <summary> <para> <para>Returns the operating system rule specified for patch groups using the patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineForPatchGroupCmdlet.PatchGroup"> <summary> <para> <para>The name of the patch group whose patch baseline should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchBaselineForPatchGroupCmdlet.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.SimpleSystemsManagement.Model.GetPatchBaselineForPatchGroupResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetPatchBaselineForPatchGroupResponse 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.SSM.GetSSMPatchGroupCmdlet"> <summary> Lists all patch groups that have been registered with patch baselines.<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.SSM.GetSSMPatchGroupCmdlet.Filter"> <summary> <para> <para>Each element in the array is a structure containing a key-value pair.</para><para>Supported keys for <c>DescribePatchGroups</c> include the following:</para><ul><li><para><b><c>NAME_PREFIX</c></b></para><para>Sample values: <c>AWS-</c> | <c>My-</c>.</para></li><li><para><b><c>OPERATING_SYSTEM</c></b></para><para>Sample values: <c>AMAZON_LINUX</c> | <c>SUSE</c> | <c>WINDOWS</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchGroupCmdlet.MaxResult"> <summary> <para> <para>The maximum number of patch groups to return (per page).</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchGroupCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMPatchGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Mappings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribePatchGroupsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribePatchGroupsResponse 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.SSM.GetSSMPatchGroupCmdlet.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.SSM.GetSSMPatchGroupCmdlet.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.SSM.GetSSMPatchGroupStateCmdlet"> <summary> Returns high-level aggregated patch compliance state information for a patch group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchGroupStateCmdlet.PatchGroup"> <summary> <para> <para>The name of the patch group whose patch snapshot should be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchGroupStateCmdlet.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.SimpleSystemsManagement.Model.DescribePatchGroupStateResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribePatchGroupStateResponse 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.SSM.GetSSMPatchGroupStateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PatchGroup parameter. The -PassThru parameter is deprecated, use -Select '^PatchGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchPropertyCmdlet"> <summary> Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as <a>CreatePatchBaseline</a>, <a>UpdatePatchBaseline</a>, <a>DescribeAvailablePatches</a>, and <a>DescribePatchBaselines</a>. <para> The following section lists the properties that can be used in filters for each major operating system type: </para><dl><dt>AMAZON_LINUX</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>CLASSIFICATION</c> | <c>SEVERITY</c></para></dd><dt>AMAZON_LINUX_2</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>CLASSIFICATION</c> | <c>SEVERITY</c></para></dd><dt>CENTOS</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>CLASSIFICATION</c> | <c>SEVERITY</c></para></dd><dt>DEBIAN</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>PRIORITY</c></para></dd><dt>MACOS</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>CLASSIFICATION</c></para></dd><dt>ORACLE_LINUX</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>CLASSIFICATION</c> | <c>SEVERITY</c></para></dd><dt>REDHAT_ENTERPRISE_LINUX</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>CLASSIFICATION</c> | <c>SEVERITY</c></para></dd><dt>SUSE</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>CLASSIFICATION</c> | <c>SEVERITY</c></para></dd><dt>UBUNTU</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>PRIORITY</c></para></dd><dt>WINDOWS</dt><dd><para> Valid properties: <c>PRODUCT</c> | <c>PRODUCT_FAMILY</c> | <c>CLASSIFICATION</c> | <c>MSRC_SEVERITY</c></para></dd></dl><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.SSM.GetSSMPatchPropertyCmdlet.OperatingSystem"> <summary> <para> <para>The operating system type for which to list patches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchPropertyCmdlet.PatchSet"> <summary> <para> <para>Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchPropertyCmdlet.Property"> <summary> <para> <para>The patch property for which you want to view patch details. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchPropertyCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchPropertyCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMPatchPropertyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Properties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribePatchPropertiesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribePatchPropertiesResponse 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.SSM.GetSSMPatchPropertyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Property parameter. The -PassThru parameter is deprecated, use -Select '^Property' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMPatchPropertyCmdlet.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.SSM.GetSSMResourceComplianceSummaryListCmdlet"> <summary> Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.<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.SSM.GetSSMResourceComplianceSummaryListCmdlet.Filter"> <summary> <para> <para>One or more filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceComplianceSummaryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceComplianceSummaryListCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMResourceComplianceSummaryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceComplianceSummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListResourceComplianceSummariesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListResourceComplianceSummariesResponse 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.SSM.GetSSMResourceComplianceSummaryListCmdlet.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.SSM.GetSSMResourceDataSyncCmdlet"> <summary> Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. <para> The number of sync configurations might be too large to return using a single call to <c>ListResourceDataSync</c>. You can limit the number of sync configurations returned by using the <c>MaxResults</c> parameter. To determine whether there are more sync configurations to list, check the value of <c>NextToken</c> in the output. If there are more sync configurations to list, you can request them by specifying the <c>NextToken</c> returned in the call to the parameter of a subsequent 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.SSM.GetSSMResourceDataSyncCmdlet.SyncType"> <summary> <para> <para>View a list of resource data syncs according to the sync type. Specify <c>SyncToDestination</c> to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify <c>SyncFromSource</c> to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceDataSyncCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceDataSyncCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results. </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.SSM.GetSSMResourceDataSyncCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceDataSyncItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListResourceDataSyncResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ListResourceDataSyncResponse 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.SSM.GetSSMResourceDataSyncCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SyncType parameter. The -PassThru parameter is deprecated, use -Select '^SyncType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceDataSyncCmdlet.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.SSM.GetSSMResourcePolicyCmdlet"> <summary> Returns an array of the <c>Policy</c> object.<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.SSM.GetSSMResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the resource to which the policies are attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourcePolicyCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourcePolicyCmdlet.NextToken"> <summary> <para> <para>A token to start the list. Use this token to get the next set of results.</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.SSM.GetSSMResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetResourcePoliciesResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetResourcePoliciesResponse 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.SSM.GetSSMResourcePolicyCmdlet.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.SSM.GetSSMResourcePolicyCmdlet.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.SSM.GetSSMResourceTagCmdlet"> <summary> Returns a list of the tags assigned to the specified resource. <para> For information about the ID format for each supported resource type, see <a>AddTagsToResource</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceTagCmdlet.ResourceId"> <summary> <para> <para>The resource ID for which you want to see a list of tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceTagCmdlet.ResourceType"> <summary> <para> <para>Returns a list of tags for a specific resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.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.SSM.GetSSMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMServiceSettingCmdlet"> <summary> <c>ServiceSetting</c> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of <c>false</c>. This means the user can't use this feature unless they change the setting to <c>true</c> and intentionally opt in for a paid feature. <para> Services map a <c>SettingId</c> object to a setting value. Amazon Web Services services teams define the default value for a <c>SettingId</c>. You can't create a new <c>SettingId</c>, but you can overwrite the default value if you have the <c>ssm:UpdateServiceSetting</c> permission for the setting. Use the <a>UpdateServiceSetting</a> API operation to change the default setting. Or use the <a>ResetServiceSetting</a> to change the value back to the original value defined by the Amazon Web Services service team. </para><para> Query the current service setting for the Amazon Web Services account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMServiceSettingCmdlet.SettingId"> <summary> <para> <para>The ID of the service setting to get. The setting ID can be one of the following.</para><ul><li><para><c>/ssm/managed-instance/default-ec2-instance-management-role</c></para></li><li><para><c>/ssm/automation/customer-script-log-destination</c></para></li><li><para><c>/ssm/automation/customer-script-log-group-name</c></para></li><li><para><c>/ssm/documents/console/public-sharing-permission</c></para></li><li><para><c>/ssm/managed-instance/activation-tier</c></para></li><li><para><c>/ssm/opsinsights/opscenter</c></para></li><li><para><c>/ssm/parameter-store/default-parameter-tier</c></para></li><li><para><c>/ssm/parameter-store/high-throughput-enabled</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMServiceSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSetting'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.GetServiceSettingResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.GetServiceSettingResponse 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.SSM.GetSSMServiceSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SettingId parameter. The -PassThru parameter is deprecated, use -Select '^SettingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMSessionCmdlet"> <summary> Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.<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.SSM.GetSSMSessionCmdlet.Filter"> <summary> <para> <para>One or more filters to limit the type of sessions returned by the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMSessionCmdlet.State"> <summary> <para> <para>The session status to retrieve a list of sessions for. For example, "Active".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMSessionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>50</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMSessionCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</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.SSM.GetSSMSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Sessions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DescribeSessionsResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DescribeSessionsResponse 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.SSM.GetSSMSessionCmdlet.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.SSM.NewSSMActivationCmdlet"> <summary> Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html">Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. <note><para> Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called <i>managed nodes</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.DefaultInstanceName"> <summary> <para> <para>The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.</para><important><para>Don't enter personally identifiable information in this field.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.Description"> <summary> <para> <para>A user-defined description of the resource that you want to register with Systems Manager. </para><important><para>Don't enter personally identifiable information in this field.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.ExpirationDate"> <summary> <para> <para>The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.IamRole"> <summary> <para> <para>The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal <c>ssm.amazonaws.com</c>. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create an IAM service role for a hybrid and multicloud environment</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para><note><para>You can't specify an IAM service-linked role for this parameter. You must create a unique role.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.RegistrationLimit"> <summary> <para> <para>Specify the maximum number of managed nodes you want to register. The default value is <c>1</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.RegistrationMetadata"> <summary> <para> <para>Reserved for internal use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=OS,Value=Windows</c></para></li><li><para><c>Key=Environment,Value=Production</c></para></li></ul><important><para>When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.</para></important><para>You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see <a>AddTagsToResource</a>. For information about how to remove tags from your managed nodes, see <a>RemoveTagsFromResource</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMActivationCmdlet.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.SimpleSystemsManagement.Model.CreateActivationResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateActivationResponse 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.SSM.NewSSMActivationCmdlet.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.SSM.NewSSMAssociationCmdlet"> <summary> A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.AlarmConfiguration_Alarm"> <summary> <para> <para>The name of the CloudWatch alarm specified in the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.ApplyOnlyAtCronInterval"> <summary> <para> <para>By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.AssociationName"> <summary> <para> <para>Specify a descriptive name for the association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.AutomationTargetParameterName"> <summary> <para> <para>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.CalendarName"> <summary> <para> <para>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change Calendar</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.ComplianceSeverity"> <summary> <para> <para>The severity level to assign to the association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.DocumentVersion"> <summary> <para> <para>The document version you want to associate with the targets. Can be a specific version or the default version.</para><important><para>State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the <c>default</c> version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to <c>default</c>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Duration"> <summary> <para> <para>The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. </para><para>The <c>Duration</c> parameter applies only when both these conditions are true:</para><ul><li><para>The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. </para></li><li><para>The command specifies the <c><a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html#systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval">ApplyOnlyAtCronInterval</a></c> parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.AlarmConfiguration_IgnorePollAlarmFailure"> <summary> <para> <para>When this value is <i>true</i>, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.InstanceId"> <summary> <para> <para>The managed node ID.</para><note><para><c>InstanceId</c> has been deprecated. To specify a managed node ID for an association, use the <c>Targets</c> parameter. Requests that include the parameter <c>InstanceID</c> with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter <c>InstanceId</c>, you can't use the parameters <c>AssociationName</c>, <c>DocumentVersion</c>, <c>MaxErrors</c>, <c>MaxConcurrency</c>, <c>OutputLocation</c>, or <c>ScheduleExpression</c>. To use these parameters, you must use the <c>Targets</c> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.MaxConcurrency"> <summary> <para> <para>The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.</para><para>If a new managed node starts and attempts to run an association while Systems Manager is running <c>MaxConcurrency</c> associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for <c>MaxConcurrency</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.MaxError"> <summary> <para> <para>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set <c>MaxError</c> to 10%, then the system stops sending the request when the sixth error is received.</para><para>Executions that are already running an association when <c>MaxErrors</c> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <c>MaxConcurrency</c> to 1 so that executions proceed one at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Name"> <summary> <para> <para>The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.</para><para>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another Amazon Web Services account.</para><para>For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:</para><para><c>arn:<i>partition</i>:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i></c></para><para>For example:</para><para><c>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</c></para><para>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, <c>AWS-ApplyPatchBaseline</c> or <c>My-Document</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.S3Location_OutputS3BucketName"> <summary> <para> <para>The name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.S3Location_OutputS3KeyPrefix"> <summary> <para> <para>The S3 bucket subfolder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.S3Location_OutputS3Region"> <summary> <para> <para>The Amazon Web Services Region of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Parameter"> <summary> <para> <para>The parameters for the runtime configuration of the document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.ScheduleExpression"> <summary> <para> <para>A cron expression when the association will be applied to the targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.ScheduleOffset"> <summary> <para> <para>Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of <c>cron(0 0 ? * THU#2 *)</c>, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para><note><para>To use offsets, you must specify the <c>ApplyOnlyAtCronInterval</c> parameter. This option tells the system not to run an association immediately after you create it. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.SyncCompliance"> <summary> <para> <para>The mode for generating association compliance. You can specify <c>AUTO</c> or <c>MANUAL</c>. In <c>AUTO</c> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <c>COMPLIANT</c>. If the association execution doesn't run successfully, the association is <c>NON-COMPLIANT</c>.</para><para>In <c>MANUAL</c> mode, you must specify the <c>AssociationId</c> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</para><para>By default, all associations use <c>AUTO</c> mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Tag"> <summary> <para> <para>Adds or overwrites one or more tags for a State Manager association. <i>Tags</i> are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.TargetLocation"> <summary> <para> <para>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.TargetMap"> <summary> <para> <para>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Target"> <summary> <para> <para>The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the <c>InstanceIds</c> key with a value of <c>*</c>. For more information about choosing targets for an association, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html">About targets and rate controls in State Manager associations</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateAssociationResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateAssociationResponse 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.SSM.NewSSMAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.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.SSM.NewSSMAssociationFromBatchCmdlet"> <summary> Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets. <para> When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified. </para><para> If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationFromBatchCmdlet.Entry"> <summary> <para> <para>One or more associations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationFromBatchCmdlet.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.SimpleSystemsManagement.Model.CreateAssociationBatchResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchResponse 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.SSM.NewSSMAssociationFromBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Entry parameter. The -PassThru parameter is deprecated, use -Select '^Entry' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationFromBatchCmdlet.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.SSM.NewSSMDocumentCmdlet"> <summary> Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html">Amazon Web Services Systems Manager Documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Attachment"> <summary> <para> <para>A list of key-value pairs that describe attachments to a version of a document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Content"> <summary> <para> <para>The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.</para><para>For examples, see the following topics in the <i>Amazon Web Services Systems Manager User Guide</i>.</para><ul><li><para><a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-console">Create an SSM document (console)</a></para></li><li><para><a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-cli">Create an SSM document (command line)</a></para></li><li><para><a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-api">Create an SSM document (API)</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.DisplayName"> <summary> <para> <para>An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the <a>UpdateDocument</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.DocumentFormat"> <summary> <para> <para>Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.DocumentType"> <summary> <para> <para>The type of document to create.</para><note><para>The <c>DeploymentStrategy</c> document type is an internal-use-only document type reserved for AppConfig.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Name"> <summary> <para> <para>A name for the SSM document.</para><important><para>You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:</para><ul><li><para><c>aws</c></para></li><li><para><c>amazon</c></para></li><li><para><c>amzn</c></para></li><li><para><c>AWSEC2</c></para></li><li><para><c>AWSConfigRemediation</c></para></li><li><para><c>AWSSupport</c></para></li></ul></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Require"> <summary> <para> <para>A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an <c>ApplicationConfiguration</c> document requires an <c>ApplicationConfigurationSchema</c> document for validation purposes. For more information, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">What is AppConfig?</a> in the <i>AppConfig User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=OS,Value=Windows</c></para></li><li><para><c>Key=Environment,Value=Production</c></para></li></ul><note><para>To add tags to an existing SSM document, use the <a>AddTagsToResource</a> operation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.TargetType"> <summary> <para> <para>Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: <c>/AWS::EC2::Instance</c>. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.VersionName"> <summary> <para> <para>An optional field specifying the version of the artifact you are creating with the document. For example, <c>Release12.1</c>. This value is unique across all versions of a document, and can't be changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateDocumentResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateDocumentResponse 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.SSM.NewSSMDocumentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Content parameter. The -PassThru parameter is deprecated, use -Select '^Content' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.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.SSM.NewSSMMaintenanceWindowCmdlet"> <summary> Creates a new maintenance window. <note><para> The value you specify for <c>Duration</c> determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for <c>Cutoff</c>. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for <c>Cutoff</c> is one hour, no maintenance window tasks can start after 5 PM. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.AllowUnassociatedTarget"> <summary> <para> <para>Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.</para><para>If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.Cutoff"> <summary> <para> <para>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.Description"> <summary> <para> <para>An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.Duration"> <summary> <para> <para>The duration of the maintenance window in hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.EndDate"> <summary> <para> <para>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. <c>EndDate</c> allows you to set a date and time in the future when the maintenance window will no longer run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.Name"> <summary> <para> <para>The name of the maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.Schedule"> <summary> <para> <para>The schedule of the maintenance window in the form of a cron or rate expression.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.ScheduleOffset"> <summary> <para> <para>The number of days to wait after the date and time specified by a cron expression before running the maintenance window.</para><para>For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.</para><para><c>cron(30 23 ? * TUE#3 *)</c></para><para>If the schedule offset is <c>2</c>, the maintenance window won't run until two days later.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.ScheduleTimezone"> <summary> <para> <para>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time Zone Database</a> on the IANA website.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.StartDate"> <summary> <para> <para>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. <c>StartDate</c> allows you to delay activation of the maintenance window until the specified future date.</para><note><para>When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=TaskType,Value=AgentUpdate</c></para></li><li><para><c>Key=OS,Value=Windows</c></para></li><li><para><c>Key=Environment,Value=Production</c></para></li></ul><note><para>To add tags to an existing maintenance window, use the <a>AddTagsToResource</a> operation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.ClientToken"> <summary> <para> <para>User-provided idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMMaintenanceWindowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateMaintenanceWindowResponse 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.SSM.NewSSMMaintenanceWindowCmdlet.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.SSM.NewSSMMaintenanceWindowCmdlet.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.SSM.NewSSMOpsItemCmdlet"> <summary> Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. <para> Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.AccountId"> <summary> <para> <para>The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.ActualEndTime"> <summary> <para> <para>The time a runbook workflow ended. Currently reported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.ActualStartTime"> <summary> <para> <para>The time a runbook workflow started. Currently reported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Category"> <summary> <para> <para>Specify a category to assign to an OpsItem. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Description"> <summary> <para> <para>User-defined text that contains information about the OpsItem, in Markdown format. </para><note><para>Provide enough information so that users viewing this OpsItem for the first time understand the issue. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Notification"> <summary> <para> <para>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.OperationalData"> <summary> <para> <para>Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.</para><important><para>Operational data keys <i>can't</i> begin with the following: <c>amazon</c>, <c>aws</c>, <c>amzn</c>, <c>ssm</c>, <c>/amazon</c>, <c>/aws</c>, <c>/amzn</c>, <c>/ssm</c>.</para></important><para>You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the <a>DescribeOpsItems</a> API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the <a>GetOpsItem</a> API operation).</para><para>Use the <c>/aws/resources</c> key in OperationalData to specify a related resource in the request. Use the <c>/aws/automations</c> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html">Create OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.OpsItemType"> <summary> <para> <para>The type of OpsItem to create. Systems Manager supports the following types of OpsItems:</para><ul><li><para><c>/aws/issue</c></para><para>This type of OpsItem is used for default OpsItems created by OpsCenter. </para></li><li><para><c>/aws/changerequest</c></para><para>This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. </para></li><li><para><c>/aws/insight</c></para><para>This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.PlannedEndTime"> <summary> <para> <para>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.PlannedStartTime"> <summary> <para> <para>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Priority"> <summary> <para> <para>The importance of this OpsItem in relation to other OpsItems in the system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.RelatedOpsItem"> <summary> <para> <para>One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Severity"> <summary> <para> <para>Specify a severity to assign to an OpsItem.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Source"> <summary> <para> <para>The origin of the OpsItem, such as Amazon EC2 or Systems Manager.</para><note><para>The source name can't contain the following strings: <c>aws</c>, <c>amazon</c>, and <c>amzn</c>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource.</para><para>Tags use a key-value pair. For example:</para><para><c>Key=Department,Value=Finance</c></para><important><para>To add tags to a new OpsItem, a user must have IAM permissions for both the <c>ssm:CreateOpsItems</c> operation and the <c>ssm:AddTagsToResource</c> operation. To add tags to an existing OpsItem, use the <a>AddTagsToResource</a> operation.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Title"> <summary> <para> <para>A short heading that describes the nature of the OpsItem and the impacted resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OpsItemId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateOpsItemResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateOpsItemResponse 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.SSM.NewSSMOpsItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Title parameter. The -PassThru parameter is deprecated, use -Select '^Title' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsItemCmdlet.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.SSM.NewSSMOpsMetadataCmdlet"> <summary> If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsMetadataCmdlet.Metadata"> <summary> <para> <para>Metadata for a new Application Manager application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsMetadataCmdlet.ResourceId"> <summary> <para> <para>A resource ID for a new Application Manager application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsMetadataCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=Environment,Value=Production</c></para></li><li><para><c>Key=Region,Value=us-east-2</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OpsMetadataArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateOpsMetadataResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateOpsMetadataResponse 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.SSM.NewSSMOpsMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMOpsMetadataCmdlet.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.SSM.NewSSMPatchBaselineCmdlet"> <summary> Creates a patch baseline. <note><para> For information about valid key-value pairs in <c>PatchFilters</c> for each supported operating system type, see <a>PatchFilter</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.ApprovedPatch"> <summary> <para> <para>A list of explicitly approved patches for the baseline.</para><para>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.ApprovedPatchesComplianceLevel"> <summary> <para> <para>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is <c>UNSPECIFIED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.ApprovedPatchesEnableNonSecurity"> <summary> <para> <para>Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is <c>false</c>. Applies to Linux managed nodes only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.Description"> <summary> <para> <para>A description of the patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.Name"> <summary> <para> <para>The name of the patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.OperatingSystem"> <summary> <para> <para>Defines the operating system the patch baseline applies to. The default value is <c>WINDOWS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.GlobalFilters_PatchFilter"> <summary> <para> <para>The set of patch filters that make up the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.ApprovalRules_PatchRule"> <summary> <para> <para>The rules that make up the rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.RejectedPatch"> <summary> <para> <para>A list of explicitly rejected patches for the baseline.</para><para>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.RejectedPatchesAction"> <summary> <para> <para>The action for Patch Manager to take on patches included in the <c>RejectedPackages</c> list.</para><ul><li><para><b><c>ALLOW_AS_DEPENDENCY</c></b>: A package in the <c>Rejected</c> patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as <c>InstalledOther</c>. This is the default action if no option is specified.</para></li><li><para><b>BLOCK</b>: Packages in the <b>Rejected patches</b> list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the <b>Rejected patches</b> list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as <i>InstalledRejected</i>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.Source"> <summary> <para> <para>Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=PatchSeverity,Value=Critical</c></para></li><li><para><c>Key=OS,Value=Windows</c></para></li></ul><note><para>To add tags to an existing patch baseline, use the <a>AddTagsToResource</a> operation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.ClientToken"> <summary> <para> <para>User-provided idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMPatchBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaselineId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreatePatchBaselineResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreatePatchBaselineResponse 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.SSM.NewSSMPatchBaselineCmdlet.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.SSM.NewSSMResourceDataSyncCmdlet"> <summary> A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: <c>SyncToDestination</c> and <c>SyncFromSource</c>. <para> You can configure Systems Manager Inventory to use the <c>SyncToDestination</c> type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html">Configuring resource data sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para><para> You can configure Systems Manager Explorer to use the <c>SyncFromSource</c> type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or <c>EntireOrganization</c> by using Organizations. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html">Setting up Systems Manager Explorer to display data from multiple accounts and Regions</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para><para> A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the <a>ListResourceDataSync</a>. </para><note><para> By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.S3Destination_AWSKMSKeyARN"> <summary> <para> <para>The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.S3Destination_BucketName"> <summary> <para> <para>The name of the S3 bucket where the aggregated data is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.DestinationDataSharing_DestinationDataSharingType"> <summary> <para> <para>The sharing data type. Only <c>Organization</c> is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.SyncSource_EnableAllOpsDataSource"> <summary> <para> <para>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html">Setting up Systems Manager Explorer to display data from multiple accounts and Regions</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.SyncSource_IncludeFutureRegion"> <summary> <para> <para>Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.AwsOrganizationsSource_OrganizationalUnit"> <summary> <para> <para>The Organizations organization units included in the sync.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.AwsOrganizationsSource_OrganizationSourceType"> <summary> <para> <para>If an Amazon Web Services organization is present, this is either <c>OrganizationalUnits</c> or <c>EntireOrganization</c>. For <c>OrganizationalUnits</c>, the data is aggregated from a set of organization units. For <c>EntireOrganization</c>, the data is aggregated from the entire Amazon Web Services organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.S3Destination_Prefix"> <summary> <para> <para>An Amazon S3 prefix for the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.S3Destination_Region"> <summary> <para> <para>The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.SyncSource_SourceRegion"> <summary> <para> <para>The <c>SyncSource</c> Amazon Web Services Regions included in the resource data sync.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.SyncSource_SourceType"> <summary> <para> <para>The type of data source for the resource data sync. <c>SourceType</c> is either <c>AwsOrganizations</c> (if an organization is present in Organizations) or <c>SingleAccountMultiRegions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.S3Destination_SyncFormat"> <summary> <para> <para>A supported sync format. The following format is currently supported: JsonSerDe</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.SyncName"> <summary> <para> <para>A name for the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.SyncType"> <summary> <para> <para>Specify <c>SyncToDestination</c> to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify <c>SyncToDestination</c>, you must provide a value for <c>S3Destination</c>. Specify <c>SyncFromSource</c> to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify <c>SyncFromSource</c>, you must provide a value for <c>SyncSource</c>. The default value is <c>SyncToDestination</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.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.SimpleSystemsManagement.Model.CreateResourceDataSyncResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SyncName parameter. The -PassThru parameter is deprecated, use -Select '^SyncName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMResourceDataSyncCmdlet.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.SSM.RegisterSSMDefaultPatchBaselineCmdlet"> <summary> Defines the default patch baseline for the relevant operating system. <para> To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify <c>arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed</c> instead of <c>pb-0574b43a65ea646ed</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMDefaultPatchBaselineCmdlet.BaselineId"> <summary> <para> <para>The ID of the patch baseline that should be the default patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMDefaultPatchBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaselineId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.RegisterDefaultPatchBaselineResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.RegisterDefaultPatchBaselineResponse 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.SSM.RegisterSSMDefaultPatchBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BaselineId parameter. The -PassThru parameter is deprecated, use -Select '^BaselineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMDefaultPatchBaselineCmdlet.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.SSM.RegisterSSMOpsItemRelatedItemCmdlet"> <summary> Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMOpsItemRelatedItemCmdlet.AssociationType"> <summary> <para> <para>The type of association that you want to create between an OpsItem and a resource. OpsCenter supports <c>IsParentOf</c> and <c>RelatesTo</c> association types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMOpsItemRelatedItemCmdlet.OpsItemId"> <summary> <para> <para>The ID of the OpsItem to which you want to associate a resource as a related item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMOpsItemRelatedItemCmdlet.ResourceType"> <summary> <para> <para>The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:</para><para><c>AWS::SSMIncidents::IncidentRecord</c>: an Incident Manager incident. </para><para><c>AWS::SSM::Document</c>: a Systems Manager (SSM) document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMOpsItemRelatedItemCmdlet.ResourceUri"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMOpsItemRelatedItemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.AssociateOpsItemRelatedItemResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.AssociateOpsItemRelatedItemResponse 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.SSM.RegisterSSMOpsItemRelatedItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsItemId parameter. The -PassThru parameter is deprecated, use -Select '^OpsItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMOpsItemRelatedItemCmdlet.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.SSM.RegisterSSMPatchBaselineForPatchGroupCmdlet"> <summary> Registers a patch baseline for a patch group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMPatchBaselineForPatchGroupCmdlet.BaselineId"> <summary> <para> <para>The ID of the patch baseline to register with the patch group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMPatchBaselineForPatchGroupCmdlet.PatchGroup"> <summary> <para> <para>The name of the patch group to be registered with the patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMPatchBaselineForPatchGroupCmdlet.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.SimpleSystemsManagement.Model.RegisterPatchBaselineForPatchGroupResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.RegisterPatchBaselineForPatchGroupResponse 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.SSM.RegisterSSMPatchBaselineForPatchGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BaselineId parameter. The -PassThru parameter is deprecated, use -Select '^BaselineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMPatchBaselineForPatchGroupCmdlet.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.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet"> <summary> Registers a target with a maintenance window. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.Description"> <summary> <para> <para>An optional description for the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.Name"> <summary> <para> <para>An optional name for the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.OwnerInformation"> <summary> <para> <para>User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.ResourceType"> <summary> <para> <para>The type of target being registered with the maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.Target"> <summary> <para> <para>The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.</para><note><para>If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.</para></note><para>You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.</para><para><b>Example 1</b>: Specify managed node IDs</para><para><c>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3></c></para><para><b>Example 2</b>: Use tag key-pairs applied to managed nodes</para><para><c>Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2></c></para><para><b>Example 3</b>: Use tag-keys applied to managed nodes</para><para><c>Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2></c></para><para><b>Example 4</b>: Use resource group names</para><para><c>Key=resource-groups:Name,Values=<resource-group-name></c></para><para><b>Example 5</b>: Use filters for resource group types</para><para><c>Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2></c></para><note><para>For <c>Key=resource-groups:ResourceTypeFilters</c>, specify resource types in the following format</para><para><c>Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC</c></para></note><para>For more information about these examples formats, including the best use case for each one, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html">Examples: Register targets with a maintenance window</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window the target should be registered with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.ClientToken"> <summary> <para> <para>User-provided idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowTargetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.RegisterTargetWithMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.RegisterTargetWithMaintenanceWindowResponse 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.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowId parameter. The -PassThru parameter is deprecated, use -Select '^WindowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTargetWithMaintenanceWindowCmdlet.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.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet"> <summary> Adds a new task to a maintenance window. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.AlarmConfiguration_Alarm"> <summary> <para> <para>The name of the CloudWatch alarm specified in the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Lambda_ClientContext"> <summary> <para> <para>Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.CloudWatchOutputConfig_CloudWatchLogGroupName"> <summary> <para> <para>The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:</para><para><c>aws/ssm/<i>SystemsManagerDocumentName</i></c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.CloudWatchOutputConfig_CloudWatchOutputEnabled"> <summary> <para> <para>Enables Systems Manager to send command output to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_Comment"> <summary> <para> <para>Information about the commands to run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.CutoffBehavior"> <summary> <para> <para>Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </para><ul><li><para><c>CONTINUE_TASK</c>: When the cutoff time is reached, any tasks that are running continue. The default value.</para></li><li><para><c>CANCEL_TASK</c>:</para><ul><li><para>For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.</para></li><li><para>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.</para></li></ul><para>The status for tasks that are not completed is <c>TIMED_OUT</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Description"> <summary> <para> <para>An optional description for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_DocumentHash"> <summary> <para> <para>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_DocumentHashType"> <summary> <para> <para>SHA-256 or SHA-1. SHA-1 hashes have been deprecated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Automation_DocumentVersion"> <summary> <para> <para>The version of an Automation runbook to use during task execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_DocumentVersion"> <summary> <para> <para>The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify <c>$DEFAULT</c>, <c>$LATEST</c>, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</para><para><c>--document-version "\$DEFAULT"</c></para><para><c>--document-version "\$LATEST"</c></para><para><c>--document-version "3"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.AlarmConfiguration_IgnorePollAlarmFailure"> <summary> <para> <para>When this value is <i>true</i>, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.StepFunctions_Input"> <summary> <para> <para>The inputs for the <c>STEP_FUNCTIONS</c> task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.MaxConcurrency"> <summary> <para> <para>The maximum number of targets this task can be run for, in parallel.</para><note><para>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</para><para>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <c>1</c>. This value doesn't affect the running of your task.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.MaxError"> <summary> <para> <para>The maximum number of errors allowed before this task stops being scheduled.</para><note><para>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</para><para>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <c>1</c>. This value doesn't affect the running of your task.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Name"> <summary> <para> <para>An optional name for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.StepFunctions_Name"> <summary> <para> <para>The name of the <c>STEP_FUNCTIONS</c> task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.NotificationConfig_NotificationArn"> <summary> <para> <para>An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.NotificationConfig_NotificationEvent"> <summary> <para> <para>The different events for which you can receive notifications. To learn more about these events, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.NotificationConfig_NotificationType"> <summary> <para> <para>The type of notification.</para><ul><li><para><c>Command</c>: Receive notification when the status of a command changes.</para></li><li><para><c>Invocation</c>: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_OutputS3BucketName"> <summary> <para> <para>The name of the Amazon Simple Storage Service (Amazon S3) bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_OutputS3KeyPrefix"> <summary> <para> <para>The S3 bucket subfolder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Automation_Parameter"> <summary> <para> <para>The parameters for the <c>AUTOMATION</c> task.</para><para>For information about specifying and updating task parameters, see <a>RegisterTaskWithMaintenanceWindow</a> and <a>UpdateMaintenanceWindowTask</a>.</para><note><para><c>LoggingInfo</c> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <c>OutputS3BucketName</c> and <c>OutputS3KeyPrefix</c> options in the <c>TaskInvocationParameters</c> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</para><para><c>TaskParameters</c> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <c>Parameters</c> option in the <c>TaskInvocationParameters</c> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</para><para>For <c>AUTOMATION</c> task types, Amazon Web Services Systems Manager ignores any values specified for these parameters.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_Parameter"> <summary> <para> <para>The parameters for the <c>RUN_COMMAND</c> task execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Lambda_Payload"> <summary> <para> <para>JSON to provide to your Lambda function as input.</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.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Priority"> <summary> <para> <para>The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Lambda_Qualifier"> <summary> <para> <para>(Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.LoggingInfo_S3BucketName"> <summary> <para> <para>The name of an S3 bucket where execution logs are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.LoggingInfo_S3KeyPrefix"> <summary> <para> <para>(Optional) The S3 bucket subfolder. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.LoggingInfo_S3Region"> <summary> <para> <para>The Amazon Web Services Region where the S3 bucket is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.ServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run <c>RegisterTaskWithMaintenanceWindow</c>.</para><para>However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html">Setting up maintenance windows</a> in the in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_ServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Target"> <summary> <para> <para>The targets (either managed nodes or maintenance window targets).</para><note><para>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para></note><para>Specify managed nodes using the following format: </para><para><c>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2></c></para><para>Specify maintenance window targets using the following format:</para><para><c>Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2></c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.TaskArn"> <summary> <para> <para>The ARN of the task to run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.TaskParameter"> <summary> <para> <para>The parameters that should be passed to the task when it is run.</para><note><para><c>TaskParameters</c> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <c>Parameters</c> option in the <c>TaskInvocationParameters</c> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.TaskType"> <summary> <para> <para>The type of task being registered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.RunCommand_TimeoutSecond"> <summary> <para> <para>If this time is reached and the command hasn't already started running, it doesn't run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window the task should be added to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.ClientToken"> <summary> <para> <para>User-provided idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowTaskId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.RegisterTaskWithMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.RegisterTaskWithMaintenanceWindowResponse 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.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RegisterSSMTaskWithMaintenanceWindowCmdlet.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.SSM.RemoveSSMActivationCmdlet"> <summary> Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMActivationCmdlet.ActivationId"> <summary> <para> <para>The ID of the activation that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMActivationCmdlet.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.SimpleSystemsManagement.Model.DeleteActivationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMActivationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActivationId parameter. The -PassThru parameter is deprecated, use -Select '^ActivationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMActivationCmdlet.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.SSM.RemoveSSMAssociationCmdlet"> <summary> Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the <c>Targets</c> parameter, then you must delete the association by using the association ID. <para> When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.AssociationId"> <summary> <para> <para>The association ID that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.InstanceId"> <summary> <para> <para>The managed node ID.</para><note><para><c>InstanceId</c> has been deprecated. To specify a managed node ID for an association, use the <c>Targets</c> parameter. Requests that include the parameter <c>InstanceID</c> with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter <c>InstanceId</c>, you can't use the parameters <c>AssociationName</c>, <c>DocumentVersion</c>, <c>MaxErrors</c>, <c>MaxConcurrency</c>, <c>OutputLocation</c>, or <c>ScheduleExpression</c>. To use these parameters, you must use the <c>Targets</c> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.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.SimpleSystemsManagement.Model.DeleteAssociationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.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.SSM.RemoveSSMDocumentCmdlet"> <summary> Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document. <para> Before you delete the document, we recommend that you use <a>DeleteAssociation</a> to disassociate all managed nodes that are associated with the document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.DocumentVersion"> <summary> <para> <para>The version of the document that you want to delete. If not provided, all versions of the document are deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.Enforce"> <summary> <para> <para>Some SSM document types require that you specify a <c>Force</c> flag before you can delete the document. For example, you must specify a <c>Force</c> flag to delete a document of type <c>ApplicationConfigurationSchema</c>. You can restrict access to the <c>Force</c> flag in an Identity and Access Management (IAM) policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.Name"> <summary> <para> <para>The name of the document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.VersionName"> <summary> <para> <para>The version name of the document that you want to delete. If not provided, all versions of the document are deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.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.SimpleSystemsManagement.Model.DeleteDocumentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.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.SSM.RemoveSSMDocumentCmdlet.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.SSM.RemoveSSMInventoryCmdlet"> <summary> Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMInventoryCmdlet.DryRun"> <summary> <para> <para>Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the <c>DryRun</c> option.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMInventoryCmdlet.SchemaDeleteOption"> <summary> <para> <para>Use the <c>SchemaDeleteOption</c> to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:</para><para>DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the <c>PutInventory</c> operation for a version greater than the disabled version.</para><para>DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMInventoryCmdlet.TypeName"> <summary> <para> <para>The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMInventoryCmdlet.ClientToken"> <summary> <para> <para>User-provided idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMInventoryCmdlet.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.SimpleSystemsManagement.Model.DeleteInventoryResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DeleteInventoryResponse 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.SSM.RemoveSSMInventoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TypeName parameter. The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMInventoryCmdlet.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.SSM.RemoveSSMMaintenanceWindowCmdlet"> <summary> Deletes a maintenance window. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMMaintenanceWindowCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMMaintenanceWindowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DeleteMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DeleteMaintenanceWindowResponse 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.SSM.RemoveSSMMaintenanceWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowId parameter. The -PassThru parameter is deprecated, use -Select '^WindowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMMaintenanceWindowCmdlet.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.SSM.RemoveSSMOpsItemCmdlet"> <summary> Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem. <important><para> Note the following important information about this operation. </para><ul><li><para> Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem. </para></li><li><para> This operation uses an <i>eventual consistency model</i>, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, <a>GetOpsItem</a>, the deleted OpsItem might still appear in the response. </para></li><li><para> This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call. </para></li><li><para> This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setting-up-cross-account.html">Setting up OpsCenter to centrally manage OpsItems across accounts</a> in the <i>Systems Manager User Guide</i>. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsItemCmdlet.OpsItemId"> <summary> <para> <para>The ID of the OpsItem that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsItemCmdlet.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.SimpleSystemsManagement.Model.DeleteOpsItemResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsItemId parameter. The -PassThru parameter is deprecated, use -Select '^OpsItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsItemCmdlet.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.SSM.RemoveSSMOpsMetadataCmdlet"> <summary> Delete OpsMetadata related to an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsMetadataCmdlet.OpsMetadataArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsMetadataCmdlet.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.SimpleSystemsManagement.Model.DeleteOpsMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsMetadataArn parameter. The -PassThru parameter is deprecated, use -Select '^OpsMetadataArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMOpsMetadataCmdlet.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.SSM.RemoveSSMParameterCmdlet"> <summary> Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMParameterCmdlet.Name"> <summary> <para> <para>The name of the parameter to delete.</para><note><para>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMParameterCmdlet.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.SimpleSystemsManagement.Model.DeleteParameterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMParameterCmdlet.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.SSM.RemoveSSMParameterCmdlet.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.SSM.RemoveSSMParameterCollectionCmdlet"> <summary> Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMParameterCollectionCmdlet.Name"> <summary> <para> <para>The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.</para><note><para>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMParameterCollectionCmdlet.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.SimpleSystemsManagement.Model.DeleteParametersResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DeleteParametersResponse 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.SSM.RemoveSSMParameterCollectionCmdlet.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.SSM.RemoveSSMParameterCollectionCmdlet.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.SSM.RemoveSSMPatchBaselineCmdlet"> <summary> Deletes a patch baseline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMPatchBaselineCmdlet.BaselineId"> <summary> <para> <para>The ID of the patch baseline to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMPatchBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaselineId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.DeletePatchBaselineResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DeletePatchBaselineResponse 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.SSM.RemoveSSMPatchBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BaselineId parameter. The -PassThru parameter is deprecated, use -Select '^BaselineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMPatchBaselineCmdlet.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.SSM.RemoveSSMResourceDataSyncCmdlet"> <summary> Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceDataSyncCmdlet.SyncName"> <summary> <para> <para>The name of the configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceDataSyncCmdlet.SyncType"> <summary> <para> <para>Specify the type of resource data sync to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceDataSyncCmdlet.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.SimpleSystemsManagement.Model.DeleteResourceDataSyncResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceDataSyncCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SyncName parameter. The -PassThru parameter is deprecated, use -Select '^SyncName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceDataSyncCmdlet.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.SSM.RemoveSSMResourcePolicyCmdlet"> <summary> Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. <ul><li><para><c>OpsItemGroup</c> - The resource policy for <c>OpsItemGroup</c> enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems). </para></li><li><para><c>Parameter</c> - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). For more information about cross-account sharing of parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourcePolicyCmdlet.PolicyHash"> <summary> <para> <para>ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourcePolicyCmdlet.PolicyId"> <summary> <para> <para>The policy ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the resource to which the policies are attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourcePolicyCmdlet.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.SimpleSystemsManagement.Model.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourcePolicyCmdlet.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.SSM.RemoveSSMResourcePolicyCmdlet.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.SSM.RemoveSSMResourceTagCmdlet"> <summary> Removes tag keys from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceTagCmdlet.ResourceId"> <summary> <para> <para>The ID of the resource from which you want to remove tags. For example:</para><para>ManagedInstance: mi-012345abcde</para><para>MaintenanceWindow: mw-012345abcde</para><para><c>Automation</c>: <c>example-c160-4567-8519-012345abcde</c></para><para>PatchBaseline: pb-012345abcde</para><para>OpsMetadata object: <c>ResourceID</c> for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, <c>ResourceID</c> is created from the strings that come after the word <c>opsmetadata</c> in the ARN. For example, an OpsMetadata object with an ARN of <c>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</c> has a <c>ResourceID</c> of either <c>aws/ssm/MyGroup/appmanager</c> or <c>/aws/ssm/MyGroup/appmanager</c>.</para><para>For the Document and Parameter values, use the name of the resource.</para><note><para>The <c>ManagedInstance</c> type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceTagCmdlet.ResourceType"> <summary> <para> <para>The type of resource from which you want to remove a tag.</para><note><para>The <c>ManagedInstance</c> type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: <c>mi-<i>ID_number</i></c>. For example, <c>mi-1a2b3c4d5e6f</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceTagCmdlet.TagKey"> <summary> <para> <para>Tag keys that you want to remove from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceTagCmdlet.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.SimpleSystemsManagement.Model.RemoveTagsFromResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMResourceTagCmdlet.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.SSM.ResetSSMParameterVersionLabelCmdlet"> <summary> Remove a label or labels from a parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResetSSMParameterVersionLabelCmdlet.Label"> <summary> <para> <para>One or more labels to delete from the specified parameter version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResetSSMParameterVersionLabelCmdlet.Name"> <summary> <para> <para>The name of the parameter from which you want to delete one or more labels.</para><note><para>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResetSSMParameterVersionLabelCmdlet.ParameterVersion"> <summary> <para> <para>The specific version of the parameter which you want to delete one or more labels from. If it isn't present, the call will fail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResetSSMParameterVersionLabelCmdlet.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.SimpleSystemsManagement.Model.UnlabelParameterVersionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UnlabelParameterVersionResponse 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.SSM.ResetSSMParameterVersionLabelCmdlet.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.SSM.ResetSSMParameterVersionLabelCmdlet.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.SSM.ResetSSMServiceSettingCmdlet"> <summary> <c>ServiceSetting</c> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. <para> Services map a <c>SettingId</c> object to a setting value. Amazon Web Services services teams define the default value for a <c>SettingId</c>. You can't create a new <c>SettingId</c>, but you can overwrite the default value if you have the <c>ssm:UpdateServiceSetting</c> permission for the setting. Use the <a>GetServiceSetting</a> API operation to view the current value. Use the <a>UpdateServiceSetting</a> API operation to change the default setting. </para><para> Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResetSSMServiceSettingCmdlet.SettingId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.</para><ul><li><para><c>/ssm/managed-instance/default-ec2-instance-management-role</c></para></li><li><para><c>/ssm/automation/customer-script-log-destination</c></para></li><li><para><c>/ssm/automation/customer-script-log-group-name</c></para></li><li><para><c>/ssm/documents/console/public-sharing-permission</c></para></li><li><para><c>/ssm/managed-instance/activation-tier</c></para></li><li><para><c>/ssm/opsinsights/opscenter</c></para></li><li><para><c>/ssm/parameter-store/default-parameter-tier</c></para></li><li><para><c>/ssm/parameter-store/high-throughput-enabled</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResetSSMServiceSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSetting'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.ResetServiceSettingResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ResetServiceSettingResponse 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.SSM.ResetSSMServiceSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SettingId parameter. The -PassThru parameter is deprecated, use -Select '^SettingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResetSSMServiceSettingCmdlet.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.SSM.ResumeSSMSessionCmdlet"> <summary> Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. <note><para> This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResumeSSMSessionCmdlet.SessionId"> <summary> <para> <para>The ID of the disconnected session to resume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResumeSSMSessionCmdlet.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.SimpleSystemsManagement.Model.ResumeSessionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.ResumeSessionResponse 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.SSM.ResumeSSMSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.ResumeSSMSessionCmdlet.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.SSM.SendSSMAutomationSignalCmdlet"> <summary> Sends a signal to an Automation execution to change the current behavior or status of the execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMAutomationSignalCmdlet.AutomationExecutionId"> <summary> <para> <para>The unique identifier for an existing Automation execution that you want to send the signal to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMAutomationSignalCmdlet.Payload"> <summary> <para> <para>The data sent with the signal. The data schema depends on the type of signal used in the request.</para><para>For <c>Approve</c> and <c>Reject</c> signal types, the payload is an optional comment that you can send with the signal type. For example:</para><para><c>Comment="Looks good"</c></para><para>For <c>StartStep</c> and <c>Resume</c> signal types, you must send the name of the Automation step to start or resume as the payload. For example:</para><para><c>StepName="step1"</c></para><para>For the <c>StopStep</c> signal type, you must send the step execution ID as the payload. For example:</para><para><c>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMAutomationSignalCmdlet.SignalType"> <summary> <para> <para>The type of signal to send to an Automation execution. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMAutomationSignalCmdlet.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.SimpleSystemsManagement.Model.SendAutomationSignalResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMAutomationSignalCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutomationExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^AutomationExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMAutomationSignalCmdlet.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.SSM.SendSSMCommandCmdlet"> <summary> Runs commands on one or more managed nodes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.AlarmConfiguration_Alarm"> <summary> <para> <para>The name of the CloudWatch alarm specified in the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.CloudWatchOutputConfig_CloudWatchLogGroupName"> <summary> <para> <para>The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:</para><para><c>aws/ssm/<i>SystemsManagerDocumentName</i></c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.CloudWatchOutputConfig_CloudWatchOutputEnabled"> <summary> <para> <para>Enables Systems Manager to send command output to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.Comment"> <summary> <para> <para>User-specified information about the command, such as a brief description of what the command should do.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.DocumentHash"> <summary> <para> <para>The Sha256 or Sha1 hash created by the system when the document was created. </para><note><para>Sha1 hashes have been deprecated.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.DocumentHashType"> <summary> <para> <para>Sha256 or Sha1.</para><note><para>Sha1 hashes have been deprecated.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.DocumentName"> <summary> <para> <para>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para><note><para>If you specify a document name or ARN that hasn't been shared with your account, you receive an <c>InvalidDocument</c> error. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.DocumentVersion"> <summary> <para> <para>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</para><para>--document-version "\$DEFAULT"</para><para>--document-version "\$LATEST"</para><para>--document-version "3"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.AlarmConfiguration_IgnorePollAlarmFailure"> <summary> <para> <para>When this value is <i>true</i>, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.InstanceId"> <summary> <para> <para>The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.</para><para>To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the <c>Targets</c> option instead. Using <c>Targets</c>, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.</para><para>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.MaxConcurrency"> <summary> <para> <para>(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is <c>50</c>. For more information about how to use <c>MaxConcurrency</c>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.MaxError"> <summary> <para> <para>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of <c>MaxErrors</c>, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is <c>0</c>. For more information about how to use <c>MaxErrors</c>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.NotificationConfig_NotificationArn"> <summary> <para> <para>An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.NotificationConfig_NotificationEvent"> <summary> <para> <para>The different events for which you can receive notifications. To learn more about these events, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.NotificationConfig_NotificationType"> <summary> <para> <para>The type of notification.</para><ul><li><para><c>Command</c>: Receive notification when the status of a command changes.</para></li><li><para><c>Invocation</c>: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.OutputS3BucketName"> <summary> <para> <para>The name of the S3 bucket where command execution responses should be stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.OutputS3KeyPrefix"> <summary> <para> <para>The directory structure within the S3 bucket where the responses should be stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.OutputS3Region"> <summary> <para> <para>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.Parameter"> <summary> <para> <para>The required and optional parameters specified in the document being run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.ServiceRoleArn"> <summary> <para> <para>The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</para><para>This role must provide the <c>sns:Publish</c> permission for your notification topic. For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.Target"> <summary> <para> <para>An array of search criteria that targets managed nodes using a <c>Key,Value</c> combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using <c>Targets</c>, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.</para><para>To send a command to a smaller number of managed nodes, you can use the <c>InstanceIds</c> option instead.</para><para>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.TimeoutSecond"> <summary> <para> <para>If this time is reached and the command hasn't already started running, it won't run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Command'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.SendCommandResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.SendCommandResponse 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.SSM.SendSSMCommandCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.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.SSM.SetSSMParameterVersionLabelCmdlet"> <summary> A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. <para> Parameter labels have the following requirements and restrictions. </para><ul><li><para> A version of a parameter can have a maximum of 10 labels. </para></li><li><para> You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. </para></li><li><para> You can move a label from one version of a parameter to another. </para></li><li><para> You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. </para></li><li><para> If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter. </para></li><li><para> A label can have a maximum of 100 characters. </para></li><li><para> Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). </para></li><li><para> Labels can't begin with a number, "<c>aws</c>" or "<c>ssm</c>" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SetSSMParameterVersionLabelCmdlet.Label"> <summary> <para> <para>One or more labels to attach to the specified parameter version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SetSSMParameterVersionLabelCmdlet.Name"> <summary> <para> <para>The parameter name on which you want to attach one or more labels.</para><note><para>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SetSSMParameterVersionLabelCmdlet.ParameterVersion"> <summary> <para> <para>The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SetSSMParameterVersionLabelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InvalidLabels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.LabelParameterVersionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.LabelParameterVersionResponse 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.SSM.SetSSMParameterVersionLabelCmdlet.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.SSM.SetSSMParameterVersionLabelCmdlet.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.SSM.StartSSMAssociationsOnceCmdlet"> <summary> Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAssociationsOnceCmdlet.AssociationId"> <summary> <para> <para>The association IDs that you want to run immediately and only one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAssociationsOnceCmdlet.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.SimpleSystemsManagement.Model.StartAssociationsOnceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAssociationsOnceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAssociationsOnceCmdlet.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.SSM.StartSSMAutomationExecutionCmdlet"> <summary> Initiates execution of an Automation runbook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.AlarmConfiguration_Alarm"> <summary> <para> <para>The name of the CloudWatch alarm specified in the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.DocumentName"> <summary> <para> <para>The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html">Sharing SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.DocumentVersion"> <summary> <para> <para>The version of the Automation runbook to use for this execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.AlarmConfiguration_IgnorePollAlarmFailure"> <summary> <para> <para>When this value is <i>true</i>, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.MaxConcurrency"> <summary> <para> <para>The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is <c>10</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.MaxError"> <summary> <para> <para>The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.</para><para>Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.Mode"> <summary> <para> <para>The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.Parameter"> <summary> <para> <para>A key-value map of execution parameters, which match the declared parameters in the Automation runbook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=environment,Value=test</c></para></li><li><para><c>Key=OS,Value=Windows</c></para></li></ul><note><para>To add tags to an existing automation, use the <a>AddTagsToResource</a> operation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.TargetLocation"> <summary> <para> <para>A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html">Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.TargetMap"> <summary> <para> <para>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.TargetParameterName"> <summary> <para> <para>The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.Target"> <summary> <para> <para>A key-value mapping to target resources. Required if you specify TargetParameterName.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.ClientToken"> <summary> <para> <para>User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.StartAutomationExecutionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.StartAutomationExecutionResponse 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.SSM.StartSSMAutomationExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentName parameter. The -PassThru parameter is deprecated, use -Select '^DocumentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMAutomationExecutionCmdlet.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.SSM.StartSSMChangeRequestExecutionCmdlet"> <summary> Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.AutoApprove"> <summary> <para> <para>Indicates whether the change request can be approved automatically without the need for manual approvals.</para><para>If <c>AutoApprovable</c> is enabled in a change template, then setting <c>AutoApprove</c> to <c>true</c> in <c>StartChangeRequestExecution</c> creates a change request that bypasses approver review.</para><note><para>Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is <c>CLOSED</c>, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again <c>OPEN</c>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.ChangeDetail"> <summary> <para> <para>User-provided details about the change. If no details are provided, content specified in the <b>Template information</b> section of the associated change template is added.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.ChangeRequestName"> <summary> <para> <para>The name of the change request associated with the runbook workflow to be run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.DocumentName"> <summary> <para> <para>The name of the change template document to run during the runbook workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.DocumentVersion"> <summary> <para> <para>The version of the change template document to run during the runbook workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.Parameter"> <summary> <para> <para>A key-value map of parameters that match the declared parameters in the change template document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.Runbook"> <summary> <para> <para>Information about the Automation runbooks that are run during the runbook workflow.</para><note><para>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.ScheduledEndTime"> <summary> <para> <para>The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.ScheduledTime"> <summary> <para> <para>The date and time specified in the change request to run the Automation runbooks.</para><note><para>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=Environment,Value=Production</c></para></li><li><para><c>Key=Region,Value=us-east-2</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.ClientToken"> <summary> <para> <para>The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.StartChangeRequestExecutionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.StartChangeRequestExecutionResponse 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.SSM.StartSSMChangeRequestExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentName parameter. The -PassThru parameter is deprecated, use -Select '^DocumentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMChangeRequestExecutionCmdlet.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.SSM.StartSSMSessionCmdlet"> <summary> Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. <note><para> Amazon Web Services CLI usage: <c>start-session</c> is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html">Install the Session Manager plugin for the Amazon Web Services CLI</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para><para> Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMSessionCmdlet.DocumentName"> <summary> <para> <para>The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, <c>SSM-SessionManagerRunShell</c>. You can call the <a>GetDocument</a> API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html">Start a session</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMSessionCmdlet.Parameter"> <summary> <para> <para>The values you want to specify for the parameters defined in the Session document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMSessionCmdlet.Reason"> <summary> <para> <para>The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMSessionCmdlet.Target"> <summary> <para> <para>The managed node to connect to for the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMSessionCmdlet.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.SimpleSystemsManagement.Model.StartSessionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.StartSessionResponse 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.SSM.StartSSMSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentName parameter. The -PassThru parameter is deprecated, use -Select '^DocumentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StartSSMSessionCmdlet.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.SSM.StopSSMAutomationExecutionCmdlet"> <summary> Stop an Automation that is currently running. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMAutomationExecutionCmdlet.AutomationExecutionId"> <summary> <para> <para>The execution ID of the Automation to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMAutomationExecutionCmdlet.Type"> <summary> <para> <para>The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMAutomationExecutionCmdlet.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.SimpleSystemsManagement.Model.StopAutomationExecutionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMAutomationExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutomationExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^AutomationExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMAutomationExecutionCmdlet.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.SSM.StopSSMCommandCmdlet"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.CommandId"> <summary> <para> <para>The ID of the command you want to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.InstanceId"> <summary> <para> <para>(Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.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.SimpleSystemsManagement.Model.CancelCommandResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.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.SSM.StopSSMMaintenanceWindowExecutionCmdlet"> <summary> Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMMaintenanceWindowExecutionCmdlet.WindowExecutionId"> <summary> <para> <para>The ID of the maintenance window execution to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMMaintenanceWindowExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WindowExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CancelMaintenanceWindowExecutionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CancelMaintenanceWindowExecutionResponse 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.SSM.StopSSMMaintenanceWindowExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^WindowExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMMaintenanceWindowExecutionCmdlet.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.SSM.StopSSMSessionCmdlet"> <summary> Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMSessionCmdlet.SessionId"> <summary> <para> <para>The ID of the session to terminate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SessionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.TerminateSessionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.TerminateSessionResponse 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.SSM.StopSSMSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMSessionCmdlet.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.SSM.UnregisterSSMManagedInstanceCmdlet"> <summary> Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMManagedInstanceCmdlet.InstanceId"> <summary> <para> <para>The ID assigned to the managed node when you registered it using the activation process. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMManagedInstanceCmdlet.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.SimpleSystemsManagement.Model.DeregisterManagedInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMManagedInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMManagedInstanceCmdlet.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.SSM.UnregisterSSMOpsItemRelatedItemCmdlet"> <summary> Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMOpsItemRelatedItemCmdlet.AssociationId"> <summary> <para> <para>The ID of the association for which you want to delete an association between the OpsItem and a related item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMOpsItemRelatedItemCmdlet.OpsItemId"> <summary> <para> <para>The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMOpsItemRelatedItemCmdlet.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.SimpleSystemsManagement.Model.DisassociateOpsItemRelatedItemResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMOpsItemRelatedItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMOpsItemRelatedItemCmdlet.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.SSM.UnregisterSSMPatchBaselineForPatchGroupCmdlet"> <summary> Removes a patch group from a patch baseline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMPatchBaselineForPatchGroupCmdlet.BaselineId"> <summary> <para> <para>The ID of the patch baseline to deregister the patch group from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMPatchBaselineForPatchGroupCmdlet.PatchGroup"> <summary> <para> <para>The name of the patch group that should be deregistered from the patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMPatchBaselineForPatchGroupCmdlet.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.SimpleSystemsManagement.Model.DeregisterPatchBaselineForPatchGroupResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DeregisterPatchBaselineForPatchGroupResponse 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.SSM.UnregisterSSMPatchBaselineForPatchGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PatchGroup parameter. The -PassThru parameter is deprecated, use -Select '^PatchGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMPatchBaselineForPatchGroupCmdlet.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.SSM.UnregisterSSMTargetFromMaintenanceWindowCmdlet"> <summary> Removes a target from a maintenance window. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTargetFromMaintenanceWindowCmdlet.Safe"> <summary> <para> <para>The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTargetFromMaintenanceWindowCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window the target should be removed from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTargetFromMaintenanceWindowCmdlet.WindowTargetId"> <summary> <para> <para>The ID of the target definition to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTargetFromMaintenanceWindowCmdlet.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.SimpleSystemsManagement.Model.DeregisterTargetFromMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DeregisterTargetFromMaintenanceWindowResponse 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.SSM.UnregisterSSMTargetFromMaintenanceWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowTargetId parameter. The -PassThru parameter is deprecated, use -Select '^WindowTargetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTargetFromMaintenanceWindowCmdlet.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.SSM.UnregisterSSMTaskFromMaintenanceWindowCmdlet"> <summary> Removes a task from a maintenance window. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTaskFromMaintenanceWindowCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window the task should be removed from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTaskFromMaintenanceWindowCmdlet.WindowTaskId"> <summary> <para> <para>The ID of the task to remove from the maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTaskFromMaintenanceWindowCmdlet.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.SimpleSystemsManagement.Model.DeregisterTaskFromMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.DeregisterTaskFromMaintenanceWindowResponse 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.SSM.UnregisterSSMTaskFromMaintenanceWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowTaskId parameter. The -PassThru parameter is deprecated, use -Select '^WindowTaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UnregisterSSMTaskFromMaintenanceWindowCmdlet.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.SSM.UpdateSSMAssociationCmdlet"> <summary> Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call <c>UpdateAssociation</c>, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the <c>Name</c> parameter. Before calling this API action, we recommend that you call the <a>DescribeAssociation</a> API operation and make a note of all optional parameters required for your <c>UpdateAssociation</c> call. <para> In order to call this API operation, a user, group, or role must be granted permission to call the <a>DescribeAssociation</a> API operation. If you don't have permission to call <c>DescribeAssociation</c>, then you receive the following error: <c>An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn></c></para><important><para> When you update an association, the association immediately runs against the specified targets. You can add the <c>ApplyOnlyAtCronInterval</c> parameter to run the association during the next schedule run. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.AlarmConfiguration_Alarm"> <summary> <para> <para>The name of the CloudWatch alarm specified in the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.ApplyOnlyAtCronInterval"> <summary> <para> <para>By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.</para><para>If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the <c>Latest</c> version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association.</para><para>You can reset this option. To do so, specify the <c>no-apply-only-at-cron-interval</c> parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID of the association you want to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.AssociationName"> <summary> <para> <para>The name of the association that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.AssociationVersion"> <summary> <para> <para>This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify <c>$LATEST</c>, or omit this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.AutomationTargetParameterName"> <summary> <para> <para>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.CalendarName"> <summary> <para> <para>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change Calendar</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.ComplianceSeverity"> <summary> <para> <para>The severity level to assign to the association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.DocumentVersion"> <summary> <para> <para>The document version you want update for the association. </para><important><para>State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the <c>default</c> version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to <c>default</c>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.Duration"> <summary> <para> <para>The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. </para><para>The <c>Duration</c> parameter applies only when both these conditions are true:</para><ul><li><para>The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. </para></li><li><para>The command specifies the <c><a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_UpdateAssociation.html#systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval">ApplyOnlyAtCronInterval</a></c> parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.AlarmConfiguration_IgnorePollAlarmFailure"> <summary> <para> <para>When this value is <i>true</i>, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.MaxConcurrency"> <summary> <para> <para>The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.</para><para>If a new managed node starts and attempts to run an association while Systems Manager is running <c>MaxConcurrency</c> associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for <c>MaxConcurrency</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.MaxError"> <summary> <para> <para>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set <c>MaxError</c> to 10%, then the system stops sending the request when the sixth error is received.</para><para>Executions that are already running an association when <c>MaxErrors</c> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <c>MaxConcurrency</c> to 1 so that executions proceed one at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.Name"> <summary> <para> <para>The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.</para><para>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.</para><para>For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:</para><para><c>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i></c></para><para>For example:</para><para><c>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</c></para><para>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, <c>AWS-ApplyPatchBaseline</c> or <c>My-Document</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.S3Location_OutputS3BucketName"> <summary> <para> <para>The name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.S3Location_OutputS3KeyPrefix"> <summary> <para> <para>The S3 bucket subfolder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.S3Location_OutputS3Region"> <summary> <para> <para>The Amazon Web Services Region of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.Parameter"> <summary> <para> <para>The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using <c>{{ssm:parameter-name}}</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.ScheduleExpression"> <summary> <para> <para>The cron expression used to schedule the association that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.ScheduleOffset"> <summary> <para> <para>Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of <c>cron(0 0 ? * THU#2 *)</c>, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para><note><para>To use offsets, you must specify the <c>ApplyOnlyAtCronInterval</c> parameter. This option tells the system not to run an association immediately after you create it. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.SyncCompliance"> <summary> <para> <para>The mode for generating association compliance. You can specify <c>AUTO</c> or <c>MANUAL</c>. In <c>AUTO</c> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <c>COMPLIANT</c>. If the association execution doesn't run successfully, the association is <c>NON-COMPLIANT</c>.</para><para>In <c>MANUAL</c> mode, you must specify the <c>AssociationId</c> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</para><para>By default, all associations use <c>AUTO</c> mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.TargetLocation"> <summary> <para> <para>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.TargetMap"> <summary> <para> <para>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.Target"> <summary> <para> <para>The targets of the association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.UpdateAssociationResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateAssociationResponse 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.SSM.UpdateSSMAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationCmdlet.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.SSM.UpdateSSMAssociationStatusCmdlet"> <summary> Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node. <para><c>UpdateAssociationStatus</c> is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the <c>InstanceId</c> legacy parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_AdditionalInfo"> <summary> <para> <para>A user-defined string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_Date"> <summary> <para> <para>The date when the status changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.InstanceId"> <summary> <para> <para>The managed node ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_Message"> <summary> <para> <para>The reason for the status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_Name"> <summary> <para> <para>The status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.UpdateAssociationStatusResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateAssociationStatusResponse 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.SSM.UpdateSSMAssociationStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.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.SSM.UpdateSSMDocumentCmdlet"> <summary> Updates one or more values for an SSM document. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.Attachment"> <summary> <para> <para>A list of key-value pairs that describe attachments to a version of a document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.Content"> <summary> <para> <para>A valid JSON or YAML string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.DisplayName"> <summary> <para> <para>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.DocumentFormat"> <summary> <para> <para>Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.DocumentVersion"> <summary> <para> <para>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <c>$LATEST</c> variable.</para><note><para>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <c>apply-only-at-cron-interval</c> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.Name"> <summary> <para> <para>The name of the SSM document that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.TargetType"> <summary> <para> <para>Specify a new target type for the document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.VersionName"> <summary> <para> <para>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.UpdateDocumentResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateDocumentResponse 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.SSM.UpdateSSMDocumentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Content parameter. The -PassThru parameter is deprecated, use -Select '^Content' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentCmdlet.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.SSM.UpdateSSMDocumentDefaultVersionCmdlet"> <summary> Set the default version of a document. <note><para> If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <c>apply-only-at-cron-interval</c> parameter. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentDefaultVersionCmdlet.DocumentVersion"> <summary> <para> <para>The version of a custom document that you want to set as the default version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentDefaultVersionCmdlet.Name"> <summary> <para> <para>The name of a custom document that you want to set as the default version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentDefaultVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Description'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.UpdateDocumentDefaultVersionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateDocumentDefaultVersionResponse 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.SSM.UpdateSSMDocumentDefaultVersionCmdlet.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.SSM.UpdateSSMDocumentDefaultVersionCmdlet.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.SSM.UpdateSSMDocumentMetadataCmdlet"> <summary> Updates information related to approval reviews for a specific version of a change template in Change Manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentMetadataCmdlet.DocumentReviews_Action"> <summary> <para> <para>The action to take on a document approval review request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentMetadataCmdlet.DocumentReviews_Comment"> <summary> <para> <para>A comment entered by a user in your organization about the document review request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentMetadataCmdlet.DocumentVersion"> <summary> <para> <para>The version of a change template in which to update approval metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentMetadataCmdlet.Name"> <summary> <para> <para>The name of the change template for which a version's metadata is to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentMetadataCmdlet.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.SimpleSystemsManagement.Model.UpdateDocumentMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMDocumentMetadataCmdlet.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.SSM.UpdateSSMDocumentMetadataCmdlet.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.SSM.UpdateSSMMaintenanceWindowCmdlet"> <summary> Updates an existing maintenance window. Only specified parameters are modified. <note><para> The value you specify for <c>Duration</c> determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for <c>Cutoff</c>. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for <c>Cutoff</c> is one hour, no maintenance window tasks can start after 5 PM. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.AllowUnassociatedTarget"> <summary> <para> <para>Whether targets must be registered with the maintenance window before tasks can be defined for those targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.Cutoff"> <summary> <para> <para>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.Description"> <summary> <para> <para>An optional description for the update request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.Duration"> <summary> <para> <para>The duration of the maintenance window in hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.Enabled"> <summary> <para> <para>Whether the maintenance window is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.EndDate"> <summary> <para> <para>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. <c>EndDate</c> allows you to set a date and time in the future when the maintenance window will no longer run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.Name"> <summary> <para> <para>The name of the maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.Replace"> <summary> <para> <para>If <c>True</c>, then all fields that are required by the <a>CreateMaintenanceWindow</a> operation are also required for this API request. Optional fields that aren't specified are set to null. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.Schedule"> <summary> <para> <para>The schedule of the maintenance window in the form of a cron or rate expression.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.ScheduleOffset"> <summary> <para> <para>The number of days to wait after the date and time specified by a cron expression before running the maintenance window.</para><para>For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.</para><para><c>cron(30 23 ? * TUE#3 *)</c></para><para>If the schedule offset is <c>2</c>, the maintenance window won't run until two days later.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.ScheduleTimezone"> <summary> <para> <para>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time Zone Database</a> on the IANA website.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.StartDate"> <summary> <para> <para>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. <c>StartDate</c> allows you to delay activation of the maintenance window until the specified future date.</para><note><para>When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.WindowId"> <summary> <para> <para>The ID of the maintenance window to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.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.SimpleSystemsManagement.Model.UpdateMaintenanceWindowResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateMaintenanceWindowResponse 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.SSM.UpdateSSMMaintenanceWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowId parameter. The -PassThru parameter is deprecated, use -Select '^WindowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowCmdlet.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.SSM.UpdateSSMMaintenanceWindowTargetCmdlet"> <summary> Modifies the target of an existing maintenance window. You can change the following: <ul><li><para> Name </para></li><li><para> Description </para></li><li><para> Owner </para></li><li><para> IDs for an ID target </para></li><li><para> Tags for a Tag target </para></li><li><para> From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see <a>Target</a>. </para></li></ul><note><para> If a parameter is null, then the corresponding field isn't modified. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.Description"> <summary> <para> <para>An optional description for the update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.Name"> <summary> <para> <para>A name for the update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.OwnerInformation"> <summary> <para> <para>User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.Replace"> <summary> <para> <para>If <c>True</c>, then all fields that are required by the <a>RegisterTargetWithMaintenanceWindow</a> operation are also required for this API request. Optional fields that aren't specified are set to null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.Target"> <summary> <para> <para>The targets to add or replace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.WindowId"> <summary> <para> <para>The maintenance window ID with which to modify the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.WindowTargetId"> <summary> <para> <para>The target ID to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.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.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTargetResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTargetResponse 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.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowTargetId parameter. The -PassThru parameter is deprecated, use -Select '^WindowTargetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTargetCmdlet.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.SSM.UpdateSSMMaintenanceWindowTaskCmdlet"> <summary> Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values: <ul><li><para><c>TaskARN</c>. For example, you can change a <c>RUN_COMMAND</c> task from <c>AWS-RunPowerShellScript</c> to <c>AWS-RunShellScript</c>. </para></li><li><para><c>ServiceRoleArn</c></para></li><li><para><c>TaskInvocationParameters</c></para></li><li><para><c>Priority</c></para></li><li><para><c>MaxConcurrency</c></para></li><li><para><c>MaxErrors</c></para></li></ul><note><para> One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para></note><para> If the value for a parameter in <c>UpdateMaintenanceWindowTask</c> is null, then the corresponding field isn't modified. If you set <c>Replace</c> to true, then all fields required by the <a>RegisterTaskWithMaintenanceWindow</a> operation are required for this request. Optional fields that aren't specified are set to null. </para><important><para> When you update a maintenance window task that has options specified in <c>TaskInvocationParameters</c>, you must provide again all the <c>TaskInvocationParameters</c> values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified <c>TaskInvocationParameters</c> values for <c>Comment</c>, <c>NotificationConfig</c>, and <c>OutputS3BucketName</c>. If you update the maintenance window task and specify only a different <c>OutputS3BucketName</c> value, the values for <c>Comment</c> and <c>NotificationConfig</c> are removed. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.AlarmConfiguration_Alarm"> <summary> <para> <para>The name of the CloudWatch alarm specified in the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Lambda_ClientContext"> <summary> <para> <para>Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.CloudWatchOutputConfig_CloudWatchLogGroupName"> <summary> <para> <para>The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:</para><para><c>aws/ssm/<i>SystemsManagerDocumentName</i></c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.CloudWatchOutputConfig_CloudWatchOutputEnabled"> <summary> <para> <para>Enables Systems Manager to send command output to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_Comment"> <summary> <para> <para>Information about the commands to run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.CutoffBehavior"> <summary> <para> <para>Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </para><ul><li><para><c>CONTINUE_TASK</c>: When the cutoff time is reached, any tasks that are running continue. The default value.</para></li><li><para><c>CANCEL_TASK</c>:</para><ul><li><para>For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.</para></li><li><para>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.</para></li></ul><para>The status for tasks that are not completed is <c>TIMED_OUT</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Description"> <summary> <para> <para>The new task description to specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_DocumentHash"> <summary> <para> <para>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_DocumentHashType"> <summary> <para> <para>SHA-256 or SHA-1. SHA-1 hashes have been deprecated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Automation_DocumentVersion"> <summary> <para> <para>The version of an Automation runbook to use during task execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_DocumentVersion"> <summary> <para> <para>The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify <c>$DEFAULT</c>, <c>$LATEST</c>, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</para><para><c>--document-version "\$DEFAULT"</c></para><para><c>--document-version "\$LATEST"</c></para><para><c>--document-version "3"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.AlarmConfiguration_IgnorePollAlarmFailure"> <summary> <para> <para>When this value is <i>true</i>, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.StepFunctions_Input"> <summary> <para> <para>The inputs for the <c>STEP_FUNCTIONS</c> task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.MaxConcurrency"> <summary> <para> <para>The new <c>MaxConcurrency</c> value you want to specify. <c>MaxConcurrency</c> is the number of targets that are allowed to run this task, in parallel.</para><note><para>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</para><para>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <c>1</c>. This value doesn't affect the running of your task.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.MaxError"> <summary> <para> <para>The new <c>MaxErrors</c> value to specify. <c>MaxErrors</c> is the maximum number of errors that are allowed before the task stops being scheduled.</para><note><para>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</para><para>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <c>1</c>. This value doesn't affect the running of your task.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Name"> <summary> <para> <para>The new task name to specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.StepFunctions_Name"> <summary> <para> <para>The name of the <c>STEP_FUNCTIONS</c> task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.NotificationConfig_NotificationArn"> <summary> <para> <para>An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.NotificationConfig_NotificationEvent"> <summary> <para> <para>The different events for which you can receive notifications. To learn more about these events, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.NotificationConfig_NotificationType"> <summary> <para> <para>The type of notification.</para><ul><li><para><c>Command</c>: Receive notification when the status of a command changes.</para></li><li><para><c>Invocation</c>: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_OutputS3BucketName"> <summary> <para> <para>The name of the Amazon Simple Storage Service (Amazon S3) bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_OutputS3KeyPrefix"> <summary> <para> <para>The S3 bucket subfolder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Automation_Parameter"> <summary> <para> <para>The parameters for the <c>AUTOMATION</c> task.</para><para>For information about specifying and updating task parameters, see <a>RegisterTaskWithMaintenanceWindow</a> and <a>UpdateMaintenanceWindowTask</a>.</para><note><para><c>LoggingInfo</c> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <c>OutputS3BucketName</c> and <c>OutputS3KeyPrefix</c> options in the <c>TaskInvocationParameters</c> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</para><para><c>TaskParameters</c> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <c>Parameters</c> option in the <c>TaskInvocationParameters</c> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</para><para>For <c>AUTOMATION</c> task types, Amazon Web Services Systems Manager ignores any values specified for these parameters.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_Parameter"> <summary> <para> <para>The parameters for the <c>RUN_COMMAND</c> task execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Lambda_Payload"> <summary> <para> <para>JSON to provide to your Lambda function as input.</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.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Priority"> <summary> <para> <para>The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Lambda_Qualifier"> <summary> <para> <para>(Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Replace"> <summary> <para> <para>If True, then all fields that are required by the <a>RegisterTaskWithMaintenanceWindow</a> operation are also required for this API request. Optional fields that aren't specified are set to null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.LoggingInfo_S3BucketName"> <summary> <para> <para>The name of an S3 bucket where execution logs are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.LoggingInfo_S3KeyPrefix"> <summary> <para> <para>(Optional) The S3 bucket subfolder. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.LoggingInfo_S3Region"> <summary> <para> <para>The Amazon Web Services Region where the S3 bucket is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.ServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run <c>RegisterTaskWithMaintenanceWindow</c>.</para><para>However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html">Setting up maintenance windows</a> in the in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_ServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.Target"> <summary> <para> <para>The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format <c>Key=instanceids,Values=instanceID_1,instanceID_2</c>. Tags are specified using the format <c> Key=tag_name,Values=tag_value</c>. </para><note><para>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.TaskArn"> <summary> <para> <para>The task ARN to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.TaskParameter"> <summary> <para> <para>The parameters to modify.</para><note><para><c>TaskParameters</c> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <c>Parameters</c> option in the <c>TaskInvocationParameters</c> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</para></note><para>The map has the following format:</para><para>Key: string, between 1 and 255 characters</para><para>Value: an array of strings, each string is between 1 and 255 characters</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.RunCommand_TimeoutSecond"> <summary> <para> <para>If this time is reached and the command hasn't already started running, it doesn't run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.WindowId"> <summary> <para> <para>The maintenance window ID that contains the task to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.WindowTaskId"> <summary> <para> <para>The task ID to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.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.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTaskResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTaskResponse 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.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WindowTaskId parameter. The -PassThru parameter is deprecated, use -Select '^WindowTaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMMaintenanceWindowTaskCmdlet.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.SSM.UpdateSSMManagedInstanceRoleCmdlet"> <summary> Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see <a>CreateActivation</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMManagedInstanceRoleCmdlet.IamRole"> <summary> <para> <para>The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal <c>ssm.amazonaws.com</c>. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create an IAM service role for a hybrid and multicloud environment</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para><note><para>You can't specify an IAM service-linked role for this parameter. You must create a unique role.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMManagedInstanceRoleCmdlet.InstanceId"> <summary> <para> <para>The ID of the managed node where you want to update the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMManagedInstanceRoleCmdlet.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.SimpleSystemsManagement.Model.UpdateManagedInstanceRoleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMManagedInstanceRoleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMManagedInstanceRoleCmdlet.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.SSM.UpdateSSMOpsItemCmdlet"> <summary> Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. <para> Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.ActualEndTime"> <summary> <para> <para>The time a runbook workflow ended. Currently reported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.ActualStartTime"> <summary> <para> <para>The time a runbook workflow started. Currently reported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.Category"> <summary> <para> <para>Specify a new category for an OpsItem.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.Description"> <summary> <para> <para>User-defined text that contains information about the OpsItem, in Markdown format. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.Notification"> <summary> <para> <para>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.OperationalData"> <summary> <para> <para>Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.</para><para>Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.</para><important><para>Operational data keys <i>can't</i> begin with the following: <c>amazon</c>, <c>aws</c>, <c>amzn</c>, <c>ssm</c>, <c>/amazon</c>, <c>/aws</c>, <c>/amzn</c>, <c>/ssm</c>.</para></important><para>You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the <a>DescribeOpsItems</a> API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the <a>GetOpsItem</a> API operation).</para><para>Use the <c>/aws/resources</c> key in OperationalData to specify a related resource in the request. Use the <c>/aws/automations</c> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.OperationalDataToDelete"> <summary> <para> <para>Keys that you want to remove from the OperationalData map.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.OpsItemArn"> <summary> <para> <para>The OpsItem Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.OpsItemId"> <summary> <para> <para>The ID of the OpsItem.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.PlannedEndTime"> <summary> <para> <para>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.PlannedStartTime"> <summary> <para> <para>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <c>/aws/changerequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.Priority"> <summary> <para> <para>The importance of this OpsItem in relation to other OpsItems in the system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.RelatedOpsItem"> <summary> <para> <para>One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.Severity"> <summary> <para> <para>Specify a new severity for an OpsItem.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.Status"> <summary> <para> <para>The OpsItem status. Status can be <c>Open</c>, <c>In Progress</c>, or <c>Resolved</c>. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.Title"> <summary> <para> <para>A short heading that describes the nature of the OpsItem and the impacted resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.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.SimpleSystemsManagement.Model.UpdateOpsItemResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsItemId parameter. The -PassThru parameter is deprecated, use -Select '^OpsItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsItemCmdlet.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.SSM.UpdateSSMOpsMetadataCmdlet"> <summary> Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsMetadataCmdlet.KeysToDelete"> <summary> <para> <para>The metadata keys to delete from the OpsMetadata object. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsMetadataCmdlet.MetadataToUpdate"> <summary> <para> <para>Metadata to add to an OpsMetadata object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsMetadataCmdlet.OpsMetadataArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the OpsMetadata Object to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OpsMetadataArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.UpdateOpsMetadataResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdateOpsMetadataResponse 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.SSM.UpdateSSMOpsMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OpsMetadataArn parameter. The -PassThru parameter is deprecated, use -Select '^OpsMetadataArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMOpsMetadataCmdlet.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.SSM.UpdateSSMPatchBaselineCmdlet"> <summary> Modifies an existing patch baseline. Fields not specified in the request are left unchanged. <note><para> For information about valid key-value pairs in <c>PatchFilters</c> for each supported operating system type, see <a>PatchFilter</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.ApprovedPatch"> <summary> <para> <para>A list of explicitly approved patches for the baseline.</para><para>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.ApprovedPatchesComplianceLevel"> <summary> <para> <para>Assigns a new compliance severity level to an existing patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.ApprovedPatchesEnableNonSecurity"> <summary> <para> <para>Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is <c>false</c>. Applies to Linux managed nodes only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.BaselineId"> <summary> <para> <para>The ID of the patch baseline to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.Description"> <summary> <para> <para>A description of the patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.Name"> <summary> <para> <para>The name of the patch baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.GlobalFilters_PatchFilter"> <summary> <para> <para>The set of patch filters that make up the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.ApprovalRules_PatchRule"> <summary> <para> <para>The rules that make up the rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.RejectedPatch"> <summary> <para> <para>A list of explicitly rejected patches for the baseline.</para><para>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.RejectedPatchesAction"> <summary> <para> <para>The action for Patch Manager to take on patches included in the <c>RejectedPackages</c> list.</para><ul><li><para><b><c>ALLOW_AS_DEPENDENCY</c></b>: A package in the <c>Rejected</c> patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as <c>InstalledOther</c>. This is the default action if no option is specified.</para></li><li><para><b>BLOCK</b>: Packages in the <b>Rejected patches</b> list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the <b>Rejected patches</b> list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as <i>InstalledRejected</i>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.Replace"> <summary> <para> <para>If True, then all fields that are required by the <a>CreatePatchBaseline</a> operation are also required for this API request. Optional fields that aren't specified are set to null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.Source"> <summary> <para> <para>Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.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.SimpleSystemsManagement.Model.UpdatePatchBaselineResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.UpdatePatchBaselineResponse 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.SSM.UpdateSSMPatchBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BaselineId parameter. The -PassThru parameter is deprecated, use -Select '^BaselineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMPatchBaselineCmdlet.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.SSM.UpdateSSMResourceDataSyncCmdlet"> <summary> Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the <c>Include only the current account</c> option, you can't edit that sync later and choose the <c>Include all accounts from my Organizations configuration</c> option. Instead, you must delete the first resource data sync, and create a new one. <note><para> This API operation only supports a resource data sync that was created with a SyncFromSource <c>SyncType</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.SyncSource_EnableAllOpsDataSource"> <summary> <para> <para>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html">Setting up Systems Manager Explorer to display data from multiple accounts and Regions</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.SyncSource_IncludeFutureRegion"> <summary> <para> <para>Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.AwsOrganizationsSource_OrganizationalUnit"> <summary> <para> <para>The Organizations organization units included in the sync.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.AwsOrganizationsSource_OrganizationSourceType"> <summary> <para> <para>If an Amazon Web Services organization is present, this is either <c>OrganizationalUnits</c> or <c>EntireOrganization</c>. For <c>OrganizationalUnits</c>, the data is aggregated from a set of organization units. For <c>EntireOrganization</c>, the data is aggregated from the entire Amazon Web Services organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.SyncSource_SourceRegion"> <summary> <para> <para>The <c>SyncSource</c> Amazon Web Services Regions included in the resource data sync.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.SyncSource_SourceType"> <summary> <para> <para>The type of data source for the resource data sync. <c>SourceType</c> is either <c>AwsOrganizations</c> (if an organization is present in Organizations) or <c>SingleAccountMultiRegions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.SyncName"> <summary> <para> <para>The name of the resource data sync you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.SyncType"> <summary> <para> <para>The type of resource data sync. The supported <c>SyncType</c> is SyncFromSource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.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.SimpleSystemsManagement.Model.UpdateResourceDataSyncResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SyncName parameter. The -PassThru parameter is deprecated, use -Select '^SyncName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMResourceDataSyncCmdlet.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.SSM.UpdateSSMServiceSettingCmdlet"> <summary> <c>ServiceSetting</c> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. <para> Services map a <c>SettingId</c> object to a setting value. Amazon Web Services services teams define the default value for a <c>SettingId</c>. You can't create a new <c>SettingId</c>, but you can overwrite the default value if you have the <c>ssm:UpdateServiceSetting</c> permission for the setting. Use the <a>GetServiceSetting</a> API operation to view the current value. Or, use the <a>ResetServiceSetting</a> to change the value back to the original value defined by the Amazon Web Services service team. </para><para> Update the service setting for the account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMServiceSettingCmdlet.SettingId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service setting to update. For example, <c>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</c>. The setting ID can be one of the following.</para><ul><li><para><c>/ssm/managed-instance/default-ec2-instance-management-role</c></para></li><li><para><c>/ssm/automation/customer-script-log-destination</c></para></li><li><para><c>/ssm/automation/customer-script-log-group-name</c></para></li><li><para><c>/ssm/documents/console/public-sharing-permission</c></para></li><li><para><c>/ssm/managed-instance/activation-tier</c></para></li><li><para><c>/ssm/opsinsights/opscenter</c></para></li><li><para><c>/ssm/parameter-store/default-parameter-tier</c></para></li><li><para><c>/ssm/parameter-store/high-throughput-enabled</c></para></li></ul><note><para>Permissions to update the <c>/ssm/managed-instance/default-ec2-instance-management-role</c> setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMServiceSettingCmdlet.SettingValue"> <summary> <para> <para>The new value to specify for the service setting. The following list specifies the available values for each setting.</para><ul><li><para>For <c>/ssm/managed-instance/default-ec2-instance-management-role</c>, enter the name of an IAM role. </para></li><li><para>For <c>/ssm/automation/customer-script-log-destination</c>, enter <c>CloudWatch</c>.</para></li><li><para>For <c>/ssm/automation/customer-script-log-group-name</c>, enter the name of an Amazon CloudWatch Logs log group.</para></li><li><para>For <c>/ssm/documents/console/public-sharing-permission</c>, enter <c>Enable</c> or <c>Disable</c>.</para></li><li><para>For <c>/ssm/managed-instance/activation-tier</c>, enter <c>standard</c> or <c>advanced</c>.</para></li><li><para> For <c>/ssm/opsinsights/opscenter</c>, enter <c>Enabled</c> or <c>Disabled</c>. </para></li><li><para>For <c>/ssm/parameter-store/default-parameter-tier</c>, enter <c>Standard</c>, <c>Advanced</c>, or <c>Intelligent-Tiering</c></para></li><li><para>For <c>/ssm/parameter-store/high-throughput-enabled</c>, enter <c>true</c> or <c>false</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMServiceSettingCmdlet.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.SimpleSystemsManagement.Model.UpdateServiceSettingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMServiceSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SettingId parameter. The -PassThru parameter is deprecated, use -Select '^SettingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMServiceSettingCmdlet.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.SSM.WriteSSMComplianceItemCmdlet"> <summary> Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. <para> ComplianceType can be one of the following: </para><ul><li><para> ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. </para></li><li><para> ExecutionType: Specify patch, association, or Custom:<c>string</c>. </para></li><li><para> ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node. </para></li><li><para> Id: The patch, association, or custom compliance ID. </para></li><li><para> Title: A title. </para></li><li><para> Status: The status of the compliance item. For example, <c>approved</c> for patches, or <c>Failed</c> for associations. </para></li><li><para> Severity: A patch severity. For example, <c>Critical</c>. </para></li><li><para> DocumentName: An SSM document name. For example, <c>AWS-RunPatchBaseline</c>. </para></li><li><para> DocumentVersion: An SSM document version number. For example, 4. </para></li><li><para> Classification: A patch classification. For example, <c>security updates</c>. </para></li><li><para> PatchBaselineId: A patch baseline ID. </para></li><li><para> PatchSeverity: A patch severity. For example, <c>Critical</c>. </para></li><li><para> PatchState: A patch state. For example, <c>InstancesWithFailedPatches</c>. </para></li><li><para> PatchGroup: The name of a patch group. </para></li><li><para> InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: <c>yyyy-MM-dd'T'HH:mm:ss'Z'</c></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.ComplianceType"> <summary> <para> <para>Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:<c>string</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.ExecutionSummary_ExecutionId"> <summary> <para> <para>An ID created by the system when <c>PutComplianceItems</c> was called. For example, <c>CommandID</c> is a valid execution ID. You can use this ID in subsequent calls.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.ExecutionSummary_ExecutionTime"> <summary> <para> <para>The time the execution ran as a datetime object that is saved in the following format: <c>yyyy-MM-dd'T'HH:mm:ss'Z'</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.ExecutionSummary_ExecutionType"> <summary> <para> <para>The type of execution. For example, <c>Command</c> is a valid execution type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.ItemContentHash"> <summary> <para> <para>MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.Item"> <summary> <para> <para>Information about the compliance as defined by the resource type. For example, for a patch compliance type, <c>Items</c> includes information about the PatchSeverity, Classification, and so on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.ResourceId"> <summary> <para> <para>Specify an ID for this resource. For a managed node, this is the node ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.ResourceType"> <summary> <para> <para>Specify the type of resource. <c>ManagedInstance</c> is currently the only supported resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.UploadType"> <summary> <para> <para>The mode for uploading compliance items. You can specify <c>COMPLETE</c> or <c>PARTIAL</c>. In <c>COMPLETE</c> mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.</para><para>In <c>PARTIAL</c> mode, the system overwrites compliance information for a specific association. The association must be configured with <c>SyncCompliance</c> set to <c>MANUAL</c>. By default, all requests use <c>COMPLETE</c> mode.</para><note><para>This attribute is only valid for association compliance.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.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.SimpleSystemsManagement.Model.PutComplianceItemsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMComplianceItemCmdlet.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.SSM.WriteSSMInventoryCmdlet"> <summary> Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMInventoryCmdlet.InstanceId"> <summary> <para> <para>An managed node ID where you want to add or update inventory items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMInventoryCmdlet.Item"> <summary> <para> <para>The inventory items that you want to add or update on managed nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMInventoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.PutInventoryResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.PutInventoryResponse 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.SSM.WriteSSMInventoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMInventoryCmdlet.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.SSM.WriteSSMParameterCmdlet"> <summary> Add a parameter to the system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.AllowedPattern"> <summary> <para> <para>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$ </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.DataType"> <summary> <para> <para>The data type for a <c>String</c> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</para><para><b>The following data type values are supported.</b></para><ul><li><para><c>text</c></para></li><li><para><c>aws:ec2:image</c></para></li><li><para><c>aws:ssm:integration</c></para></li></ul><para>When you create a <c>String</c> parameter and specify <c>aws:ec2:image</c>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <c>ami-12345abcdeEXAMPLE</c>, and that the specified AMI is available in your Amazon Web Services account.</para><note><para>If the action is successful, the service sends back an HTTP 200 response which indicates a successful <c>PutParameter</c> call for all cases except for data type <c>aws:ec2:image</c>. If you call <c>PutParameter</c> with <c>aws:ec2:image</c> data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The <c>aws:ec2:image</c> value is validated asynchronously, and the <c>PutParameter</c> call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your <c>aws:ec2:image</c> parameters are created successfully, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html">Setting up notifications or trigger actions based on Parameter Store events</a>. For more information about AMI format validation , see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html">Native parameter support for Amazon Machine Image IDs</a>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Description"> <summary> <para> <para>Information about the parameter that you want to add to the system. Optional but recommended.</para><important><para>Don't enter personally identifiable information in this field.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.KeyId"> <summary> <para> <para>The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the <c>SecureString</c> data type.</para><para>If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account which is not as secure as using a custom key.</para><ul><li><para>To use a custom KMS key, choose the <c>SecureString</c> data type with the <c>Key ID</c> parameter.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Name"> <summary> <para> <para>The fully qualified name of the parameter that you want to add to the system.</para><note><para>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</para></note><para>The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <c>/Dev/DBServer/MySQL/db-string13</c></para><para>Naming Constraints:</para><ul><li><para>Parameter names are case sensitive.</para></li><li><para>A parameter name must be unique within an Amazon Web Services Region</para></li><li><para>A parameter name can't be prefixed with "<c>aws</c>" or "<c>ssm</c>" (case-insensitive).</para></li><li><para>Parameter names can include only the following symbols and letters: <c>a-zA-Z0-9_.-</c></para><para>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <c>/Dev/Production/East/Project-ABC/MyParameter</c></para></li><li><para>A parameter name can't include spaces.</para></li><li><para>Parameter hierarchies are limited to a maximum depth of fifteen levels.</para></li></ul><para>For additional information about valid values for parameter names, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para><note><para>The maximum length constraint of 2048 characters listed below includes 1037 characters reserved for internal use by Systems Manager. The maximum length for a parameter name that you create is 1011 characters. This includes the characters in the ARN that precede the name you specify, such as <c>arn:aws:ssm:us-east-2:111122223333:parameter/</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Overwrite"> <summary> <para> <para>Overwrite an existing parameter. The default value is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Policy"> <summary> <para> <para>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a capability of Amazon Web Services Systems Manager supports the following policy types:</para><para>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</para><para>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</para><para>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</para><para>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html">Assigning parameter policies</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:</para><ul><li><para><c>Key=Resource,Value=S3bucket</c></para></li><li><para><c>Key=OS,Value=Windows</c></para></li><li><para><c>Key=ParameterType,Value=LicenseKey</c></para></li></ul><note><para>To add tags to an existing Systems Manager parameter, use the <a>AddTagsToResource</a> operation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Tier"> <summary> <para> <para>The parameter tier to assign to a parameter.</para><para>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost. </para><para>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para><para>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters. </para><para>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. </para><para><b>Using the Default Tier Configuration</b></para><para>In <c>PutParameter</c> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</para><para>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</para><ul><li><para><b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters. </para></li><li><para><b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced. </para><para>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</para><para>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary. </para></li></ul><para>Options that require an advanced parameter include the following:</para><ul><li><para>The content size of the parameter is more than 4 KB.</para></li><li><para>The parameter uses a parameter policy.</para></li><li><para>More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.</para></li></ul><para>For more information about configuring the default tier option, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier">Specifying a default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Type"> <summary> <para> <para>The type of parameter that you want to add to the system.</para><note><para><c>SecureString</c> isn't currently supported for CloudFormation templates.</para></note><para>Items in a <c>StringList</c> must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the <c>String</c> data type.</para><important><para>Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Value"> <summary> <para> <para>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</para><note><para>Parameters can't be referenced or nested in the values of other parameters. You can't include <c>{{}}</c> or <c>{{ssm:<i>parameter-name</i>}}</c> in a parameter value.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMParameterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Version'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.PutParameterResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.PutParameterResponse 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.SSM.WriteSSMParameterCmdlet.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.SSM.WriteSSMParameterCmdlet.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.SSM.WriteSSMResourcePolicyCmdlet"> <summary> Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. <ul><li><para><c>OpsItemGroup</c> - The resource policy for <c>OpsItemGroup</c> enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems). </para></li><li><para><c>Parameter</c> - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). </para><para> To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a>. For information about changing an existing standard parameter to an advanced parameter, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#parameter-store-advanced-parameters-enabling">Changing a standard parameter to an advanced parameter</a>. </para><para> To share a <c>SecureString</c> parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html">KMS concepts</a> in the <i>Key Management Service Developer Guide</i>. </para><important><para> While you can share a parameter using the Systems Manager <c>PutResourcePolicy</c> operation, we recommend using Resource Access Manager (RAM) instead. This is because using <c>PutResourcePolicy</c> requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> API operation. Otherwise, the parameter won't be returned by the Systems Manager <a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html">DescribeParameters</a> API operation using the <c>--shared</c> option. </para><para> For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html#share">Sharing a parameter</a> in the <i>Amazon Web Services Systems Manager User Guide</i></para></important></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMResourcePolicyCmdlet.Policy"> <summary> <para> <para>A policy you want to associate with a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMResourcePolicyCmdlet.PolicyHash"> <summary> <para> <para>ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMResourcePolicyCmdlet.PolicyId"> <summary> <para> <para>The policy ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the resource to which you want to attach a policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.WriteSSMResourcePolicyCmdlet.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.SimpleSystemsManagement.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.PutResourcePolicyResponse 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.SSM.WriteSSMResourcePolicyCmdlet.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.SSM.WriteSSMResourcePolicyCmdlet.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> |