AWS.Tools.ObservabilityAdmin.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ObservabilityAdmin</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet"> <summary> Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.<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.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.AccountIdentifier"> <summary> <para> <para> A list of AWS account IDs used to filter the resources to those associated with the specified accounts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.ResourceIdentifierPrefix"> <summary> <para> <para> A string used to filter resources in the organization which have a <c>ResourceIdentifier</c> starting with the <c>ResourceIdentifierPrefix</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.ResourceTag"> <summary> <para> <para> A key-value pair to filter resources in the organization based on tags associated with the resource. Fore more information about tags, see <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html">What are tags?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.ResourceType"> <summary> <para> <para> A list of resource types used to filter resources in the organization. If this parameter is provided, the resources will be returned in the same order used in the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.TelemetryConfigurationState"> <summary> <para> <para> A key-value pair to filter resources in the organization based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.MaxResult"> <summary> <para> <para> A number field used to limit the number of results within the returned list. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.NextToken"> <summary> <para> <para> The token for the next set of items to return. A previous call provides this token. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TelemetryConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ObservabilityAdmin.Model.ListResourceTelemetryForOrganizationResponse). Specifying the name of a property of type Amazon.ObservabilityAdmin.Model.ListResourceTelemetryForOrganizationResponse 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.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceIdentifierPrefix parameter. The -PassThru parameter is deprecated, use -Select '^ResourceIdentifierPrefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryForOrganizationListCmdlet.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.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet"> <summary> Returns a list of telemetry configurations for AWS resources supported by telemetry config. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a>.<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.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.ResourceIdentifierPrefix"> <summary> <para> <para> A string used to filter resources which have a <c>ResourceIdentifier</c> starting with the <c>ResourceIdentifierPrefix</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.ResourceTag"> <summary> <para> <para> A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html">What are tags?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.ResourceType"> <summary> <para> <para> A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used in the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.TelemetryConfigurationState"> <summary> <para> <para> A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.MaxResult"> <summary> <para> <para> A number field used to limit the number of results within the returned list. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.NextToken"> <summary> <para> <para> The token for the next set of items to return. A previous call generates this token. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TelemetryConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ObservabilityAdmin.Model.ListResourceTelemetryResponse). Specifying the name of a property of type Amazon.ObservabilityAdmin.Model.ListResourceTelemetryResponse 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.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceIdentifierPrefix parameter. The -PassThru parameter is deprecated, use -Select '^ResourceIdentifierPrefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNResourceTelemetryListCmdlet.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.CWOADMN.GetCWOADMNTelemetryEvaluationStatusCmdlet"> <summary> Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNTelemetryEvaluationStatusCmdlet.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.ObservabilityAdmin.Model.GetTelemetryEvaluationStatusResponse). Specifying the name of a property of type Amazon.ObservabilityAdmin.Model.GetTelemetryEvaluationStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNTelemetryEvaluationStatusForOrganizationCmdlet"> <summary> This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an AWS Organization or an assigned Delegated Admin Account of AWS CloudWatch telemetry config. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.GetCWOADMNTelemetryEvaluationStatusForOrganizationCmdlet.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.ObservabilityAdmin.Model.GetTelemetryEvaluationStatusForOrganizationResponse). Specifying the name of a property of type Amazon.ObservabilityAdmin.Model.GetTelemetryEvaluationStatusForOrganizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWOADMN.StartCWOADMNTelemetryEvaluationCmdlet"> <summary> This action begins onboarding onboarding the caller AWS account to the telemetry config feature. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StartCWOADMNTelemetryEvaluationCmdlet.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.ObservabilityAdmin.Model.StartTelemetryEvaluationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StartCWOADMNTelemetryEvaluationCmdlet.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.CWOADMN.StartCWOADMNTelemetryEvaluationForOrganizationCmdlet"> <summary> This actions begins onboarding the organization and all member accounts to the telemetry config feature. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StartCWOADMNTelemetryEvaluationForOrganizationCmdlet.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.ObservabilityAdmin.Model.StartTelemetryEvaluationForOrganizationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StartCWOADMNTelemetryEvaluationForOrganizationCmdlet.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.CWOADMN.StopCWOADMNTelemetryEvaluationCmdlet"> <summary> This action begins offboarding the caller AWS account from the telemetry config feature. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StopCWOADMNTelemetryEvaluationCmdlet.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.ObservabilityAdmin.Model.StopTelemetryEvaluationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StopCWOADMNTelemetryEvaluationCmdlet.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.CWOADMN.StopCWOADMNTelemetryEvaluationForOrganizationCmdlet"> <summary> This action offboards the Organization of the caller AWS account from thef telemetry config feature. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StopCWOADMNTelemetryEvaluationForOrganizationCmdlet.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.ObservabilityAdmin.Model.StopTelemetryEvaluationForOrganizationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWOADMN.StopCWOADMNTelemetryEvaluationForOrganizationCmdlet.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> |