AWS.Tools.AWSHealth.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AWSHealth</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.HLTH.DisableHLTHHealthServiceAccessForOrganizationCmdlet"> <summary> Calling this operation disables Health from working with AWS Organizations. This does not remove the Service Linked Role (SLR) from the the master account in your organization. Use the IAM console, API, or AWS CLI to remove the SLR if desired. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.DisableHLTHHealthServiceAccessForOrganizationCmdlet.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.AWSHealth.Model.DisableHealthServiceAccessForOrganizationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.DisableHLTHHealthServiceAccessForOrganizationCmdlet.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.HLTH.EnableHLTHHealthServiceAccessForOrganizationCmdlet"> <summary> Calling this operation enables AWS Health to work with AWS Organizations. This applies a Service Linked Role (SLR) to the master account in the organization. To learn more about the steps in this process, visit enabling service access for AWS Health in AWS Organizations. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.EnableHLTHHealthServiceAccessForOrganizationCmdlet.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.AWSHealth.Model.EnableHealthServiceAccessForOrganizationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.EnableHLTHHealthServiceAccessForOrganizationCmdlet.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.HLTH.GetHLTHAffectedAccountsForOrganizationCmdlet"> <summary> Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. <para> Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account. </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.HLTH.GetHLTHAffectedAccountsForOrganizationCmdlet.EventArn"> <summary> <para> <para>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i></code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedAccountsForOrganizationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return in one batch, between 10 and 100, inclusive.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedAccountsForOrganizationCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedAccountsForOrganizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AffectedAccounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeAffectedAccountsForOrganizationResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeAffectedAccountsForOrganizationResponse 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.HLTH.GetHLTHAffectedAccountsForOrganizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventArn parameter. The -PassThru parameter is deprecated, use -Select '^EventArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedAccountsForOrganizationCmdlet.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.HLTH.GetHLTHAffectedEntitiesForOrganizationCmdlet"> <summary> Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. <para> At least one event ARN and account ID are required. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent. </para><para> Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account. </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.HLTH.GetHLTHAffectedEntitiesForOrganizationCmdlet.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.GetHLTHAffectedEntitiesForOrganizationCmdlet.OrganizationEntityFilter"> <summary> <para> <para>A JSON set of elements including the <code>awsAccountId</code> and the <code>eventArn</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntitiesForOrganizationCmdlet.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.GetHLTHAffectedEntitiesForOrganizationCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntitiesForOrganizationCmdlet.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.AWSHealth.Model.DescribeAffectedEntitiesForOrganizationResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeAffectedEntitiesForOrganizationResponse 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.HLTH.GetHLTHAffectedEntitiesForOrganizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Locale parameter. The -PassThru parameter is deprecated, use -Select '^Locale' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntitiesForOrganizationCmdlet.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.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 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.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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHAffectedEntityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse 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.HLTH.GetHLTHAffectedEntityCmdlet.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.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="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEntityAggregateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EntityAggregates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeEntityAggregatesResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEntityAggregatesResponse 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.HLTH.GetHLTHEntityAggregateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventArn parameter. The -PassThru parameter is deprecated, use -Select '^EventArn' instead. This parameter will be removed in a future version. </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 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.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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeEventsResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEventsResponse 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.HLTH.GetHLTHEventCmdlet.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.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 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.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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventAggregates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeEventAggregatesResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEventAggregatesResponse 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.HLTH.GetHLTHEventAggregateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AggregateField parameter. The -PassThru parameter is deprecated, use -Select '^AggregateField' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventAggregateCmdlet.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.HLTH.GetHLTHEventDetailCmdlet"> <summary> Returns detailed information about one or more specified events. Information includes standard event data (region, service, and so on, 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="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventDetailCmdlet.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.AWSHealth.Model.DescribeEventDetailsResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEventDetailsResponse 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.HLTH.GetHLTHEventDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventArn parameter. The -PassThru parameter is deprecated, use -Select '^EventArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventDetailsForOrganizationCmdlet"> <summary> Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by <a>DescribeEventsForOrganization</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>DescribeAffectedEntitiesForOrganization</a> operation. <para> Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventDetailsForOrganizationCmdlet.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.GetHLTHEventDetailsForOrganizationCmdlet.OrganizationEventDetailFilter"> <summary> <para> <para>A set of JSON elements that includes the <code>awsAccountId</code> and the <code>eventArn</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventDetailsForOrganizationCmdlet.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.AWSHealth.Model.DescribeEventDetailsForOrganizationResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEventDetailsForOrganizationResponse 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.HLTH.GetHLTHEventDetailsForOrganizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Locale parameter. The -PassThru parameter is deprecated, use -Select '^Locale' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet"> <summary> Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria. Events are returned in a summary form and do not include the accounts impacted, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the <a>DescribeAffectedAccountsForOrganization</a>, <a>DescribeEventDetailsForOrganization</a>, and <a>DescribeAffectedEntitiesForOrganization</a> operations. <para> If no filter criteria are specified, all events across your organization are returned. Results are sorted by <code>lastModifiedTime</code>, starting with the most recent. </para><para> Before you can call this operation, you must first enable Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account. </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.HLTH.GetHLTHEventsForOrganizationCmdlet.Filter_AwsAccountId"> <summary> <para> <para>A list of 12-digit AWS account numbers that contains the affected entities.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.Filter_EntityArn"> <summary> <para> <para>REPLACEME</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.Filter_EntityValue"> <summary> <para> <para>A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.Filter_EventStatusCode"> <summary> <para> <para>A list of event status codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.Filter_EventTypeCategory"> <summary> <para> <para>REPLACEME</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.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.GetHLTHEventsForOrganizationCmdlet.EndTime_From"> <summary> <para> <para>The starting date and time of a time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.LastUpdatedTime_From"> <summary> <para> <para>The starting date and time of a time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.StartTime_From"> <summary> <para> <para>The starting date and time of a time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.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.GetHLTHEventsForOrganizationCmdlet.Filter_Region"> <summary> <para> <para>A list of AWS Regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.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.GetHLTHEventsForOrganizationCmdlet.EndTime_To"> <summary> <para> <para>The ending date and time of a time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.LastUpdatedTime_To"> <summary> <para> <para>The ending date and time of a time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.StartTime_To"> <summary> <para> <para>The ending date and time of a time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return in one batch, between 10 and 100, inclusive.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeEventsForOrganizationResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEventsForOrganizationResponse 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.HLTH.GetHLTHEventsForOrganizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Locale parameter. The -PassThru parameter is deprecated, use -Select '^Locale' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventsForOrganizationCmdlet.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.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 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.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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHEventTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventTypes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeEventTypesResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEventTypesResponse 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.HLTH.GetHLTHEventTypeCmdlet.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.HLTH.GetHLTHHealthServiceStatusForOrganizationCmdlet"> <summary> This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HLTH.GetHLTHHealthServiceStatusForOrganizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HealthServiceAccessStatusForOrganization'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeHealthServiceStatusForOrganizationResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeHealthServiceStatusForOrganizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> </members> </doc> |