AWS.Tools.PrometheusService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.PrometheusService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PROM.AddPROMResourceTagCmdlet"> <summary> Creates tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.AddPROMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.AddPROMResourceTagCmdlet.Tag"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.AddPROMResourceTagCmdlet.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.PrometheusService.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.AddPROMResourceTagCmdlet.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.PROM.AddPROMResourceTagCmdlet.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.PROM.GetPROMAlertManagerDefinitionCmdlet"> <summary> Describes an alert manager definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMAlertManagerDefinitionCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMAlertManagerDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AlertManagerDefinition'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.DescribeAlertManagerDefinitionResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.DescribeAlertManagerDefinitionResponse 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.PROM.GetPROMAlertManagerDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMDefaultScraperConfigurationCmdlet"> <summary> Gets a default configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMDefaultScraperConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.GetDefaultScraperConfigurationResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.GetDefaultScraperConfigurationResponse 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.PROM.GetPROMLoggingConfigurationCmdlet"> <summary> Describes logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMLoggingConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to vend logs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMLoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LoggingConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.DescribeLoggingConfigurationResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.DescribeLoggingConfigurationResponse 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.PROM.GetPROMLoggingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMResourceTagCmdlet"> <summary> Lists the tags you have assigned to the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMResourceTagCmdlet.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.PrometheusService.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.PrometheusService.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.PROM.GetPROMResourceTagCmdlet.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.PROM.GetPROMRuleGroupsNamespaceCmdlet"> <summary> Describe a rule groups namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceCmdlet.Name"> <summary> <para> <para>The rule groups namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuleGroupsNamespace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.DescribeRuleGroupsNamespaceResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.DescribeRuleGroupsNamespaceResponse 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.PROM.GetPROMRuleGroupsNamespaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet"> <summary> Lists rule groups namespaces. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.Name"> <summary> <para> <para>Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.MaxResult"> <summary> <para> <para>Maximum results to return in response (default=100, maximum=1000).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.NextToken"> <summary> <para> <para>Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuleGroupsNamespaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.ListRuleGroupsNamespacesResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.ListRuleGroupsNamespacesResponse 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.PROM.GetPROMRuleGroupsNamespaceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperCmdlet"> <summary> Describe an existing scraper. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperCmdlet.ScraperId"> <summary> <para> <para>The IDs of the scraper to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Scraper'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.DescribeScraperResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.DescribeScraperResponse 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.PROM.GetPROMScraperCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScraperId parameter. The -PassThru parameter is deprecated, use -Select '^ScraperId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet"> <summary> Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet.Filter"> <summary> <para> <para>A list of scraper filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet.MaxResult"> <summary> <para> <para>Maximum results to return in response (default=100, maximum=1000).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet.NextToken"> <summary> <para> <para>Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Scrapers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.ListScrapersResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.ListScrapersResponse 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.PROM.GetPROMWorkspaceCmdlet"> <summary> Describes an existing AMP workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.DescribeWorkspaceResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.DescribeWorkspaceResponse 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.PROM.GetPROMWorkspaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet"> <summary> Lists all AMP workspaces, including workspaces being created or deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet.Alias"> <summary> <para> <para>Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet.MaxResult"> <summary> <para> <para>Maximum results to return in response (default=100, maximum=1000).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet.NextToken"> <summary> <para> <para>Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workspaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.ListWorkspacesResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.ListWorkspacesResponse 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.PROM.GetPROMWorkspaceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Alias parameter. The -PassThru parameter is deprecated, use -Select '^Alias' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet"> <summary> Create an alert manager definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet.Data"> <summary> <para> <para>The alert manager definition data.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace in which to create the alert manager definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.CreateAlertManagerDefinitionResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.CreateAlertManagerDefinitionResponse 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.PROM.NewPROMAlertManagerDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet.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.PROM.NewPROMLoggingConfigurationCmdlet"> <summary> Create logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.LogGroupArn"> <summary> <para> <para>The ARN of the CW log group to which the vended log data will be published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to vend logs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.CreateLoggingConfigurationResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.CreateLoggingConfigurationResponse 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.PROM.NewPROMLoggingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.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.PROM.NewPROMRuleGroupsNamespaceCmdlet"> <summary> Create a rule group namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.Data"> <summary> <para> <para>The namespace data that define the rule groups.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.Name"> <summary> <para> <para>The rule groups namespace name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.Tag"> <summary> <para> <para>Optional, user-provided tags for this rule groups namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace in which to create the rule group namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.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.PrometheusService.Model.CreateRuleGroupsNamespaceResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.CreateRuleGroupsNamespaceResponse 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.PROM.NewPROMRuleGroupsNamespaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.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.PROM.NewPROMScraperCmdlet"> <summary> Create a scraper. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.Alias"> <summary> <para> <para>An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.EksConfiguration_ClusterArn"> <summary> <para> <para>The ARN of an EKS cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.ScrapeConfiguration_ConfigurationBlob"> <summary> <para> <para>Binary data representing a Prometheus configuration file.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.EksConfiguration_SecurityGroupId"> <summary> <para> <para>A list of security group IDs specified for VPC configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.EksConfiguration_SubnetId"> <summary> <para> <para>A list of subnet IDs specified for VPC configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.Tag"> <summary> <para> <para>Optional, user-provided tags for this scraper.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.AmpConfiguration_WorkspaceArn"> <summary> <para> <para>The ARN of an AMP workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.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.PrometheusService.Model.CreateScraperResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.CreateScraperResponse 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.PROM.NewPROMScraperCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Alias parameter. The -PassThru parameter is deprecated, use -Select '^Alias' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.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.PROM.NewPROMWorkspaceCmdlet"> <summary> Creates a new AMP workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.Alias"> <summary> <para> <para>An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.KmsKeyArn"> <summary> <para> <para>Optional, customer managed KMS key used to encrypt data for this workspace</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.Tag"> <summary> <para> <para>Optional, user-provided tags for this workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.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.PrometheusService.Model.CreateWorkspaceResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.CreateWorkspaceResponse 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.PROM.NewPROMWorkspaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Alias parameter. The -PassThru parameter is deprecated, use -Select '^Alias' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.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.PROM.RemovePROMAlertManagerDefinitionCmdlet"> <summary> Deletes an alert manager definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMAlertManagerDefinitionCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace in which to delete the alert manager definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMAlertManagerDefinitionCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMAlertManagerDefinitionCmdlet.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.PrometheusService.Model.DeleteAlertManagerDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMAlertManagerDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMAlertManagerDefinitionCmdlet.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.PROM.RemovePROMLoggingConfigurationCmdlet"> <summary> Delete logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMLoggingConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to vend logs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMLoggingConfigurationCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMLoggingConfigurationCmdlet.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.PrometheusService.Model.DeleteLoggingConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMLoggingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMLoggingConfigurationCmdlet.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.PROM.RemovePROMResourceTagCmdlet"> <summary> Deletes tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMResourceTagCmdlet.TagKey"> <summary> <para> <para>One or more tag keys</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMResourceTagCmdlet.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.PrometheusService.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMResourceTagCmdlet.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.PROM.RemovePROMResourceTagCmdlet.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.PROM.RemovePROMRuleGroupsNamespaceCmdlet"> <summary> Delete a rule groups namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.Name"> <summary> <para> <para>The rule groups namespace name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to delete rule group definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.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.PrometheusService.Model.DeleteRuleGroupsNamespaceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.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.PROM.RemovePROMScraperCmdlet"> <summary> Deletes a scraper. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMScraperCmdlet.ScraperId"> <summary> <para> <para>The ID of the scraper to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMScraperCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMScraperCmdlet.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.PrometheusService.Model.DeleteScraperResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.DeleteScraperResponse 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.PROM.RemovePROMScraperCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScraperId parameter. The -PassThru parameter is deprecated, use -Select '^ScraperId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMScraperCmdlet.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.PROM.RemovePROMWorkspaceCmdlet"> <summary> Deletes an AMP workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMWorkspaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMWorkspaceCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMWorkspaceCmdlet.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.PrometheusService.Model.DeleteWorkspaceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMWorkspaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMWorkspaceCmdlet.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.PROM.UpdatePROMLoggingConfigurationCmdlet"> <summary> Update logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMLoggingConfigurationCmdlet.LogGroupArn"> <summary> <para> <para>The ARN of the CW log group to which the vended log data will be published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMLoggingConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to vend logs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMLoggingConfigurationCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMLoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.UpdateLoggingConfigurationResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.UpdateLoggingConfigurationResponse 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.PROM.UpdatePROMLoggingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMLoggingConfigurationCmdlet.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.PROM.UpdatePROMWorkspaceAliasCmdlet"> <summary> Updates an AMP workspace alias. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.Alias"> <summary> <para> <para>The new alias of the workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.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.PrometheusService.Model.UpdateWorkspaceAliasResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.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.PROM.WritePROMAlertManagerDefinitionCmdlet"> <summary> Update an alert manager definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMAlertManagerDefinitionCmdlet.Data"> <summary> <para> <para>The alert manager definition data.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMAlertManagerDefinitionCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace in which to update the alert manager definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMAlertManagerDefinitionCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMAlertManagerDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.PutAlertManagerDefinitionResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.PutAlertManagerDefinitionResponse 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.PROM.WritePROMAlertManagerDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkspaceId parameter. The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMAlertManagerDefinitionCmdlet.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.PROM.WritePROMRuleGroupsNamespaceCmdlet"> <summary> Update a rule groups namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.Data"> <summary> <para> <para>The namespace data that define the rule groups.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.Name"> <summary> <para> <para>The rule groups namespace name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace in which to update the rule group namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.ClientToken"> <summary> <para> <para>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.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.PrometheusService.Model.PutRuleGroupsNamespaceResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.PutRuleGroupsNamespaceResponse 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.PROM.WritePROMRuleGroupsNamespaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.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> |