AWS.Tools.InternetMonitor.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.InternetMonitor</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CWIM.AddCWIMResourceTagCmdlet"> <summary> Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor. <para> A minimum of one tag is required for this call. It returns an error if you use the <code>TagResource</code> request with 0 tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.AddCWIMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.AddCWIMResourceTagCmdlet.Tag"> <summary> <para> <para>Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.AddCWIMResourceTagCmdlet.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.InternetMonitor.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.AddCWIMResourceTagCmdlet.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.CWIM.AddCWIMResourceTagCmdlet.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.CWIM.GetCWIMHealthEventCmdlet"> <summary> Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all of the information related to the event by location. <para> The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type, and so on. </para><para> Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventCmdlet.EventId"> <summary> <para> <para>The internally generated identifier of a health event. Because <code>EventID</code> contains the forward slash (“/”) character, you must URL-encode the <code>EventID</code> field in the request URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventCmdlet.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.InternetMonitor.Model.GetHealthEventResponse). Specifying the name of a property of type Amazon.InternetMonitor.Model.GetHealthEventResponse 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.CWIM.GetCWIMHealthEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventId parameter. The -PassThru parameter is deprecated, use -Select '^EventId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventListCmdlet"> <summary> Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status. <note><para> Health events that have start times during the time frame that is requested are not included in the list of health events. </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.CWIM.GetCWIMHealthEventListCmdlet.EndTime"> <summary> <para> <para>The time when a health event ended. If the health event is still ongoing, then the end time is not set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventListCmdlet.EventStatus"> <summary> <para> <para>The status of a health event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventListCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventListCmdlet.StartTime"> <summary> <para> <para>The time when a health event started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventListCmdlet.MaxResult"> <summary> <para> <para>The number of health event objects that you want to return with this call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventListCmdlet.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/>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.CWIM.GetCWIMHealthEventListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HealthEvents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.InternetMonitor.Model.ListHealthEventsResponse). Specifying the name of a property of type Amazon.InternetMonitor.Model.ListHealthEventsResponse 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.CWIM.GetCWIMHealthEventListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitorName parameter. The -PassThru parameter is deprecated, use -Select '^MonitorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMHealthEventListCmdlet.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.CWIM.GetCWIMMonitorCmdlet"> <summary> Gets information about a monitor in Amazon CloudWatch Internet 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.CWIM.GetCWIMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMMonitorCmdlet.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.InternetMonitor.Model.GetMonitorResponse). Specifying the name of a property of type Amazon.InternetMonitor.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="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitorName parameter. The -PassThru parameter is deprecated, use -Select '^MonitorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMMonitorListCmdlet"> <summary> Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.<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.CWIM.GetCWIMMonitorListCmdlet.MonitorStatus"> <summary> <para> <para>The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself.</para><para>For information about the statuses for a monitor, see <a href="https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html"> Monitor</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMMonitorListCmdlet.MaxResult"> <summary> <para> <para>The number of monitor objects that you want to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMMonitorListCmdlet.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/>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.CWIM.GetCWIMMonitorListCmdlet.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.InternetMonitor.Model.ListMonitorsResponse). Specifying the name of a property of type Amazon.InternetMonitor.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.CWIM.GetCWIMMonitorListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitorStatus parameter. The -PassThru parameter is deprecated, use -Select '^MonitorStatus' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMMonitorListCmdlet.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.CWIM.GetCWIMResourceTagCmdlet"> <summary> Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.GetCWIMResourceTagCmdlet.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.InternetMonitor.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.InternetMonitor.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.CWIM.GetCWIMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWIM.NewCWIMMonitorCmdlet"> <summary> Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories. <para> After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are impairing traffic. Internet Monitor can also diagnose whether the impairment is on the Amazon Web Services network or is an issue with an internet service provider (ISP). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.NewCWIMMonitorCmdlet.MaxCityNetworksToMonitor"> <summary> <para> <para>The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored for your resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.NewCWIMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.NewCWIMMonitorCmdlet.Resource"> <summary> <para> <para>The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).</para><para>You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of resources.</para><note><para>If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.NewCWIMMonitorCmdlet.Tag"> <summary> <para> <para>The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.NewCWIMMonitorCmdlet.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.CWIM.NewCWIMMonitorCmdlet.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.InternetMonitor.Model.CreateMonitorResponse). Specifying the name of a property of type Amazon.InternetMonitor.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.CWIM.NewCWIMMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitorName parameter. The -PassThru parameter is deprecated, use -Select '^MonitorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.NewCWIMMonitorCmdlet.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.CWIM.RemoveCWIMMonitorCmdlet"> <summary> Deletes a monitor in Amazon CloudWatch Internet Monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMMonitorCmdlet.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.InternetMonitor.Model.DeleteMonitorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitorName parameter. The -PassThru parameter is deprecated, use -Select '^MonitorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMMonitorCmdlet.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.CWIM.RemoveCWIMResourceTagCmdlet"> <summary> Removes a tag from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a tag you remove a resource from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMResourceTagCmdlet.TagKey"> <summary> <para> <para>Tag keys that you remove from a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMResourceTagCmdlet.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.InternetMonitor.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.RemoveCWIMResourceTagCmdlet.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.CWIM.RemoveCWIMResourceTagCmdlet.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.CWIM.UpdateCWIMMonitorCmdlet"> <summary> Updates a monitor. You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.MaxCityNetworksToMonitor"> <summary> <para> <para>The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored for your resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.ResourcesToAdd"> <summary> <para> <para>The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).</para><para>You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of resources.</para><note><para>If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.ResourcesToRemove"> <summary> <para> <para>The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.Status"> <summary> <para> <para>The status for a monitor. The accepted values for <code>Status</code> with the <code>UpdateMonitor</code> API call are the following: <code>ACTIVE</code> and <code>INACTIVE</code>. The following values are <i>not</i> accepted: <code>PENDING</code>, and <code>ERROR</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.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.InternetMonitor.Model.UpdateMonitorResponse). Specifying the name of a property of type Amazon.InternetMonitor.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.CWIM.UpdateCWIMMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitorName parameter. The -PassThru parameter is deprecated, use -Select '^MonitorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWIM.UpdateCWIMMonitorCmdlet.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> |