AWS.Tools.NetworkFlowMonitor.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.NetworkFlowMonitor</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.NFM.AddNFMResourceTagCmdlet"> <summary> Adds a tag to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.AddNFMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.AddNFMResourceTagCmdlet.Tag"> <summary> <para> <para>The tags for a resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.AddNFMResourceTagCmdlet.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.NetworkFlowMonitor.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.AddNFMResourceTagCmdlet.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.NFM.GetNFMMonitorCmdlet"> <summary> Gets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMMonitorCmdlet.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.NetworkFlowMonitor.Model.GetMonitorResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetMonitorResponse 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.NFM.GetNFMMonitorListCmdlet"> <summary> List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the <c>STATUS</c> parameter.<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.NFM.GetNFMMonitorListCmdlet.MonitorStatus"> <summary> <para> <para>The status of a monitor. The status can be one of the following</para><ul><li><para><c>PENDING</c>: The monitor is in the process of being created.</para></li><li><para><c>ACTIVE</c>: The monitor is active.</para></li><li><para><c>INACTIVE</c>: The monitor is inactive.</para></li><li><para><c>ERROR</c>: Monitor creation failed due to an error.</para></li><li><para><c>DELETING</c>: The monitor is in the process of being deleted.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMMonitorListCmdlet.MaxResult"> <summary> <para> <para>The number of query results that you want to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMMonitorListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMMonitorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Monitors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.ListMonitorsResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.ListMonitorsResponse 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.NFM.GetNFMMonitorListCmdlet.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.NFM.GetNFMQueryResultsMonitorTopContributorCmdlet"> <summary> Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor. <para> Create a query ID for this call by calling the corresponding API call to start the query, <c>StartQueryMonitorTopContributors</c>. Use the scope ID that was returned for your account by <c>CreateScope</c>. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </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.NFM.GetNFMQueryResultsMonitorTopContributorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsMonitorTopContributorCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsMonitorTopContributorCmdlet.MaxResult"> <summary> <para> <para>The number of query results that you want to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsMonitorTopContributorCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsMonitorTopContributorCmdlet.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.NetworkFlowMonitor.Model.GetQueryResultsMonitorTopContributorsResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetQueryResultsMonitorTopContributorsResponse 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.NFM.GetNFMQueryResultsMonitorTopContributorCmdlet.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.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorCmdlet"> <summary> Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. <para> This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see <c>GetQueryResultsWorkloadInsightsTopContributorsData</c>. </para><para> Create a query ID for this call by calling the corresponding API call to start the query, <c>StartQueryWorkloadInsightsTopContributors</c>. Use the scope ID that was returned for your account by <c>CreateScope</c>. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </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.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorCmdlet.MaxResult"> <summary> <para> <para>The number of query results that you want to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TopContributors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.GetQueryResultsWorkloadInsightsTopContributorsResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetQueryResultsWorkloadInsightsTopContributorsResponse 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.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorCmdlet.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.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorsDataCmdlet"> <summary> Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID. <para> This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see <c>GetQueryResultsWorkloadInsightsTopContributors</c>. </para><para> Create a query ID for this call by calling the corresponding API call to start the query, <c>StartQueryWorkloadInsightsTopContributorsData</c>. Use the scope ID that was returned for your account by <c>CreateScope</c>. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </para><para> The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions. </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.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorsDataCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorsDataCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorsDataCmdlet.MaxResult"> <summary> <para> <para>The number of query results that you want to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorsDataCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorsDataCmdlet.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.NetworkFlowMonitor.Model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetQueryResultsWorkloadInsightsTopContributorsDataResponse 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.NFM.GetNFMQueryResultsWorkloadInsightsTopContributorsDataCmdlet.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.NFM.GetNFMQueryStatusMonitorTopContributorCmdlet"> <summary> Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor. <para> When you create a query, use this call to check the status of the query to make sure that it has has <c>SUCCEEDED</c> before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, <c>StartQueryMonitorTopContributors</c>. </para><para> When you run a query, use this call to check the status of the query to make sure that the query has <c>SUCCEEDED</c> before you review the results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusMonitorTopContributorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusMonitorTopContributorCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusMonitorTopContributorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.GetQueryStatusMonitorTopContributorsResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetQueryStatusMonitorTopContributorsResponse 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.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorCmdlet"> <summary> Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights. <para> When you start a query, use this call to check the status of the query to make sure that it has has <c>SUCCEEDED</c> before you review the results. Use the same query ID that you used for the corresponding API call to start the query, <c>StartQueryWorkloadInsightsTopContributors</c>. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.GetQueryStatusWorkloadInsightsTopContributorsResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetQueryStatusWorkloadInsightsTopContributorsResponse 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.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorsDataCmdlet"> <summary> Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights. <para> When you start a query, use this call to check the status of the query to make sure that it has has <c>SUCCEEDED</c> before you review the results. Use the same query ID that you used for the corresponding API call to start the query, <c>StartQueryWorkloadInsightsTopContributorsData</c>. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </para><para> The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorsDataCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorsDataCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <c>CreateScope</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMQueryStatusWorkloadInsightsTopContributorsDataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.GetQueryStatusWorkloadInsightsTopContributorsDataResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetQueryStatusWorkloadInsightsTopContributorsDataResponse 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.NFM.GetNFMResourceTagCmdlet"> <summary> Returns all the tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.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="T:Amazon.PowerShell.Cmdlets.NFM.GetNFMScopeCmdlet"> <summary> Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMScopeCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <c>CreateScope</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMScopeCmdlet.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.NetworkFlowMonitor.Model.GetScopeResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.GetScopeResponse 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.NFM.GetNFMScopeListCmdlet"> <summary> List all the scopes for an 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.NFM.GetNFMScopeListCmdlet.MaxResult"> <summary> <para> <para>The number of query results that you want to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMScopeListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.GetNFMScopeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Scopes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.ListScopesResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.ListScopesResponse 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.NFM.GetNFMScopeListCmdlet.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.NFM.NewNFMMonitorCmdlet"> <summary> Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMMonitorCmdlet.LocalResource"> <summary> <para> <para>The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Relational Database Service (RDS)), the EC2 instance hosting the web service, which also runs the agent, is the local resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMMonitorCmdlet.RemoteResource"> <summary> <para> <para>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMMonitorCmdlet.ScopeArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the scope for the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMMonitorCmdlet.Tag"> <summary> <para> <para>The tags for a monitor. You can add a maximum of 200 tags.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMMonitorCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMMonitorCmdlet.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.NetworkFlowMonitor.Model.CreateMonitorResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.CreateMonitorResponse 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.NFM.NewNFMMonitorCmdlet.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.NFM.NewNFMScopeCmdlet"> <summary> Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope. <para> When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMScopeCmdlet.Tag"> <summary> <para> <para>The tags for a scope. You can add a maximum of 200 tags.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMScopeCmdlet.Target"> <summary> <para> <para>The targets to define the scope to be monitored. Currently, a target is an Amazon Web Services account.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMScopeCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.NewNFMScopeCmdlet.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.NetworkFlowMonitor.Model.CreateScopeResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.CreateScopeResponse 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.NFM.NewNFMScopeCmdlet.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.NFM.RemoveNFMMonitorCmdlet"> <summary> Deletes a monitor in Network Flow Monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMMonitorCmdlet.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.NetworkFlowMonitor.Model.DeleteMonitorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMMonitorCmdlet.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.NFM.RemoveNFMResourceTagCmdlet"> <summary> Removes a tag from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMResourceTagCmdlet.TagKey"> <summary> <para> <para>Keys that you specified when you tagged a resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMResourceTagCmdlet.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.NetworkFlowMonitor.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMResourceTagCmdlet.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.NFM.RemoveNFMScopeCmdlet"> <summary> Deletes a scope that has been defined. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMScopeCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMScopeCmdlet.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.NetworkFlowMonitor.Model.DeleteScopeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.RemoveNFMScopeCmdlet.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.NFM.StartNFMQueryMonitorTopContributorCmdlet"> <summary> Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for. <para> The call returns a query ID that you can use with <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsMonitorTopContributors.html"> GetQueryResultsMonitorTopContributors</a> to run the query and return the top contributors for a specific monitor. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryMonitorTopContributorCmdlet.DestinationCategory"> <summary> <para> <para>The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following: </para><ul><li><para><c>INTRA_AZ</c>: Top contributor network flows within a single Availability Zone</para></li><li><para><c>INTER_AZ</c>: Top contributor network flows between Availability Zones</para></li><li><para><c>INTER_VPC</c>: Top contributor network flows between VPCs</para></li><li><para><c>AMAZON_S3</c>: Top contributor network flows to or from Amazon S3</para></li><li><para><c>AMAZON_DYNAMODB</c>: Top contributor network flows to or from Amazon Dynamo DB</para></li><li><para><c>UNCLASSIFIED</c>: Top contributor network flows that do not have a bucket classification</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryMonitorTopContributorCmdlet.EndTime"> <summary> <para> <para>The timestamp that is the date and time end of the period that you want to retrieve results for with your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryMonitorTopContributorCmdlet.MetricName"> <summary> <para> <para>The metric that you want to query top contributors for. That is, you can specify a metric with this call and return the top contributor network flows, for that type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryMonitorTopContributorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryMonitorTopContributorCmdlet.StartTime"> <summary> <para> <para>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryMonitorTopContributorCmdlet.Limit"> <summary> <para> <para>The maximum number of top contributors to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryMonitorTopContributorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.StartQueryMonitorTopContributorsResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.StartQueryMonitorTopContributorsResponse 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.NFM.StartNFMQueryMonitorTopContributorCmdlet.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.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet"> <summary> Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for. <para> The call returns a query ID that you can use with <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributors.html"> GetQueryResultsWorkloadInsightsTopContributors</a> to run the query and return the top contributors for the workload insights for a scope. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.DestinationCategory"> <summary> <para> <para>The destination category for a top contributors row. Destination categories can be one of the following: </para><ul><li><para><c>INTRA_AZ</c>: Top contributor network flows within a single Availability Zone</para></li><li><para><c>INTER_AZ</c>: Top contributor network flows between Availability Zones</para></li><li><para><c>INTER_VPC</c>: Top contributor network flows between VPCs</para></li><li><para><c>AWS_SERVICES</c>: Top contributor network flows to or from Amazon Web Services services</para></li><li><para><c>UNCLASSIFIED</c>: Top contributor network flows that do not have a bucket classification</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.EndTime"> <summary> <para> <para>The timestamp that is the date and time end of the period that you want to retrieve results for with your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.MetricName"> <summary> <para> <para>The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <c>CreateScope</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.StartTime"> <summary> <para> <para>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.Limit"> <summary> <para> <para>The maximum number of top contributors to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.StartQueryWorkloadInsightsTopContributorsResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.StartQueryWorkloadInsightsTopContributorsResponse 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.NFM.StartNFMQueryWorkloadInsightsTopContributorCmdlet.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.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet"> <summary> Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for. <para> The call returns a query ID that you can use with <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributorsData.html"> GetQueryResultsWorkloadInsightsTopContributorsData</a> to run the query and return the data for the top contributors for the workload insights for a scope. </para><para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet.DestinationCategory"> <summary> <para> <para>The destination category for a top contributors. Destination categories can be one of the following: </para><ul><li><para><c>INTRA_AZ</c>: Top contributor network flows within a single Availability Zone</para></li><li><para><c>INTER_AZ</c>: Top contributor network flows between Availability Zones</para></li><li><para><c>INTER_VPC</c>: Top contributor network flows between VPCs</para></li><li><para><c>AWS_SERVICES</c>: Top contributor network flows to or from Amazon Web Services services</para></li><li><para><c>UNCLASSIFIED</c>: Top contributor network flows that do not have a bucket classification</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet.EndTime"> <summary> <para> <para>The timestamp that is the date and time end of the period that you want to retrieve results for with your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet.MetricName"> <summary> <para> <para>The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet.StartTime"> <summary> <para> <para>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFlowMonitor.Model.StartQueryWorkloadInsightsTopContributorsDataResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.StartQueryWorkloadInsightsTopContributorsDataResponse 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.NFM.StartNFMQueryWorkloadInsightsTopContributorsDataCmdlet.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.NFM.StopNFMQueryMonitorTopContributorCmdlet"> <summary> Stop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name. <para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryMonitorTopContributorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryMonitorTopContributorCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryMonitorTopContributorCmdlet.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.NetworkFlowMonitor.Model.StopQueryMonitorTopContributorsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryMonitorTopContributorCmdlet.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.NFM.StopNFMQueryWorkloadInsightsTopContributorCmdlet"> <summary> Stop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. <para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorCmdlet.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.NetworkFlowMonitor.Model.StopQueryWorkloadInsightsTopContributorsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorCmdlet.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.NFM.StopNFMQueryWorkloadInsightsTopContributorsDataCmdlet"> <summary> Stop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. <para> Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorsDataCmdlet.QueryId"> <summary> <para> <para>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorsDataCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorsDataCmdlet.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.NetworkFlowMonitor.Model.StopQueryWorkloadInsightsTopContributorsDataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.StopNFMQueryWorkloadInsightsTopContributorsDataCmdlet.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.NFM.UpdateNFMMonitorCmdlet"> <summary> Update a monitor to add or remove local or remote resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMMonitorCmdlet.LocalResourcesToAdd"> <summary> <para> <para>The local resources to add, as an array of resources with identifiers and types.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMMonitorCmdlet.LocalResourcesToRemove"> <summary> <para> <para>The local resources to remove, as an array of resources with identifiers and types.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMMonitorCmdlet.RemoteResourcesToAdd"> <summary> <para> <para>The remove resources to add, as an array of resources with identifiers and types.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMMonitorCmdlet.RemoteResourcesToRemove"> <summary> <para> <para>The remove resources to remove, as an array of resources with identifiers and types.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMMonitorCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMMonitorCmdlet.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.NetworkFlowMonitor.Model.UpdateMonitorResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.UpdateMonitorResponse 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.NFM.UpdateNFMMonitorCmdlet.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.NFM.UpdateNFMScopeCmdlet"> <summary> Update a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMScopeCmdlet.ResourcesToAdd"> <summary> <para> <para>A list of resources to add to a scope.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMScopeCmdlet.ResourcesToDelete"> <summary> <para> <para>A list of resources to delete from a scope.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMScopeCmdlet.ScopeId"> <summary> <para> <para>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NFM.UpdateNFMScopeCmdlet.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.NetworkFlowMonitor.Model.UpdateScopeResponse). Specifying the name of a property of type Amazon.NetworkFlowMonitor.Model.UpdateScopeResponse 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.NFM.UpdateNFMScopeCmdlet.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> |