AWS.Tools.AWSHealth.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.AWSHealth</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet">
            <summary>
            Returns a list of entities that have been affected by the specified events, based
            on the specified filter criteria. Entities can refer to individual customer resources,
            groups of customer resources, or any other construct, depending on the AWS service.
            Events that have impact beyond that of the affected entities, or where the extent
            of impact is unknown, include at least one entity indicating this.
             
              
            <para>
            At least one event ARN is required. Results are sorted by the <code>lastUpdatedTime</code>
            of the entity, starting with the most recent.
            </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Filter_EntityArn">
            <summary>
            <para>
            <para>A list of entity ARNs (unique identifiers).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Filter_EntityValue">
            <summary>
            <para>
            <para>A list of IDs for affected entities.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Filter_EventArn">
            <summary>
            <para>
            <para>A list of event ARNs (unique identifiers). For example: <code>"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
            "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Filter_LastUpdatedTime">
            <summary>
            <para>
            <para>A list of the most recent dates and times that the entity was updated.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Locale">
            <summary>
            <para>
            <para>The locale (language) to return information in. English (en) is the default and the
            only supported value at this time.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Filter_StatusCode">
            <summary>
            <para>
            <para>A list of entity status codes (<code>IMPAIRED</code>, <code>UNIMPAIRED</code>, or
            <code>UNKNOWN</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Filter_Tag">
            <summary>
            <para>
            <para>A map of entity tags attached to the affected entity.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of items to return in one batch, between 10 and 100, inclusive.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.NextToken">
            <summary>
            <para>
            <para>If the results of a search are large, only a portion of the results are returned,
            and a <code>nextToken</code> pagination token is returned in the response. To retrieve
            the next batch of results, reissue the search request and include the returned token.
            When all results have been returned, the response does not contain a pagination token
            value.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEntityAggregateCmdlet">
            <summary>
            Returns the number of entities that are affected by each of the specified events.
            If no events are specified, the counts of all affected entities are returned.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEntityAggregateCmdlet.EventArn">
            <summary>
            <para>
            <para>A list of event ARNs (unique identifiers). For example: <code>"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
            "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"</code></para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet">
            <summary>
            Returns information about events that meet the specified filter criteria. Events are
            returned in a summary form and do not include the detailed description, any additional
            metadata that depends on the event type, or any affected resources. To retrieve that
            information, use the <a>DescribeEventDetails</a> and <a>DescribeAffectedEntities</a>
            operations.
             
              
            <para>
            If no filter criteria are specified, all events are returned. Results are sorted by
            <code>lastModifiedTime</code>, starting with the most recent.
            </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_AvailabilityZone">
            <summary>
            <para>
            <para>A list of AWS availability zones.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_EndTime">
            <summary>
            <para>
            <para>A list of dates and times that the event ended.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_EntityArn">
            <summary>
            <para>
            <para>A list of entity ARNs (unique identifiers).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_EntityValue">
            <summary>
            <para>
            <para>A list of entity identifiers, such as EC2 instance IDs (<code>i-34ab692e</code>) or
            EBS volumes (<code>vol-426ab23e</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_EventArn">
            <summary>
            <para>
            <para>A list of event ARNs (unique identifiers). For example: <code>"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
            "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_EventStatusCode">
            <summary>
            <para>
            <para>A list of event status codes.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_EventTypeCategory">
            <summary>
            <para>
            <para>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
            or <code>accountNotification</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_EventTypeCode">
            <summary>
            <para>
            <para>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_LastUpdatedTime">
            <summary>
            <para>
            <para>A list of dates and times that the event was last updated.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Locale">
            <summary>
            <para>
            <para>The locale (language) to return information in. English (en) is the default and the
            only supported value at this time.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_Region">
            <summary>
            <para>
            <para>A list of AWS regions.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_Service">
            <summary>
            <para>
            <para>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_StartTime">
            <summary>
            <para>
            <para>A list of dates and times that the event began.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Filter_Tag">
            <summary>
            <para>
            <para>A map of entity tags attached to the affected entity.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of items to return in one batch, between 10 and 100, inclusive.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.NextToken">
            <summary>
            <para>
            <para>If the results of a search are large, only a portion of the results are returned,
            and a <code>nextToken</code> pagination token is returned in the response. To retrieve
            the next batch of results, reissue the search request and include the returned token.
            When all results have been returned, the response does not contain a pagination token
            value.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet">
            <summary>
            Returns the number of events of each event type (issue, scheduled change, and account
            notification). If no filter is specified, the counts of all events in each category
            are returned.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.AggregateField">
            <summary>
            <para>
            <para>The only currently supported value is <code>eventTypeCategory</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_AvailabilityZone">
            <summary>
            <para>
            <para>A list of AWS availability zones.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_EndTime">
            <summary>
            <para>
            <para>A list of dates and times that the event ended.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_EntityArn">
            <summary>
            <para>
            <para>A list of entity ARNs (unique identifiers).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_EntityValue">
            <summary>
            <para>
            <para>A list of entity identifiers, such as EC2 instance IDs (<code>i-34ab692e</code>) or
            EBS volumes (<code>vol-426ab23e</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_EventArn">
            <summary>
            <para>
            <para>A list of event ARNs (unique identifiers). For example: <code>"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
            "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_EventStatusCode">
            <summary>
            <para>
            <para>A list of event status codes.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_EventTypeCategory">
            <summary>
            <para>
            <para>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
            or <code>accountNotification</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_EventTypeCode">
            <summary>
            <para>
            <para>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_LastUpdatedTime">
            <summary>
            <para>
            <para>A list of dates and times that the event was last updated.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_Region">
            <summary>
            <para>
            <para>A list of AWS regions.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_Service">
            <summary>
            <para>
            <para>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_StartTime">
            <summary>
            <para>
            <para>A list of dates and times that the event began.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Filter_Tag">
            <summary>
            <para>
            <para>A map of entity tags attached to the affected entity.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of items to return in one batch, between 10 and 100, inclusive.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.NextToken">
            <summary>
            <para>
            <para>If the results of a search are large, only a portion of the results are returned,
            and a <code>nextToken</code> pagination token is returned in the response. To retrieve
            the next batch of results, reissue the search request and include the returned token.
            When all results have been returned, the response does not contain a pagination token
            value.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventDetailCmdlet">
            <summary>
            Returns detailed information about one or more specified events. Information includes
            standard event data (region, service, etc., as returned by <a>DescribeEvents</a>),
            a detailed event description, and possible additional metadata that depends upon the
            nature of the event. Affected entities are not included; to retrieve those, use the
            <a>DescribeAffectedEntities</a> operation.
             
              
            <para>
            If a specified event cannot be retrieved, an error message is returned for that event.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventDetailCmdlet.EventArn">
            <summary>
            <para>
            <para>A list of event ARNs (unique identifiers). For example: <code>"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
            "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventDetailCmdlet.Locale">
            <summary>
            <para>
            <para>The locale (language) to return information in. English (en) is the default and the
            only supported value at this time.</para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet">
            <summary>
            Returns the event types that meet the specified filter criteria. If no filter criteria
            are specified, all event types are returned, in no particular order.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet.Filter_EventTypeCategory">
            <summary>
            <para>
            <para>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
            or <code>accountNotification</code>).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet.Filter_EventTypeCode">
            <summary>
            <para>
            <para>A list of event type codes.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet.Locale">
            <summary>
            <para>
            <para>The locale (language) to return information in. English (en) is the default and the
            only supported value at this time.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet.Filter_Service">
            <summary>
            <para>
            <para>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of items to return in one batch, between 10 and 100, inclusive.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet.NextToken">
            <summary>
            <para>
            <para>If the results of a search are large, only a portion of the results are returned,
            and a <code>nextToken</code> pagination token is returned in the response. To retrieve
            the next batch of results, reissue the search request and include the returned token.
            When all results have been returned, the response does not contain a pagination token
            value.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
    </members>
</doc>