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> The <c>TagResource</c> operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces. <para> If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.AddPROMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the workspace or rule groups namespace to apply tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.AddPROMResourceTagCmdlet.Tag"> <summary> <para> <para>The list of tag keys and values to associate with the resource.</para><para>Keys may not begin with <c>aws:</c>.</para> </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.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> Retrieves the full information about the alert manager definition for a workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMAlertManagerDefinitionCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to retrieve the alert manager definition from.</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="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMDefaultScraperConfigurationCmdlet"> <summary> The <c>GetDefaultScraperConfiguration</c> operation returns the default scraper configuration used when Amazon EKS creates a scraper for you. </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> Returns complete information about the current logging configuration of the workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMLoggingConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to describe the logging configuration for.</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="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMResourceTagCmdlet"> <summary> The <c>ListTagsForResource</c> operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to list tages for. Must be a workspace or rule groups namespace 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="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceCmdlet"> <summary> Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use <c>ListRuleGroupsNamespaces</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceCmdlet.Name"> <summary> <para> <para>The name of the rule groups namespace that you want information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace containing the rule groups namespace.</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="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet"> <summary> Returns a list of rule groups namespaces in a workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.Name"> <summary> <para> <para>Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace containing the rule groups namespaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMRuleGroupsNamespaceListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.</para><para>For example, if your initial request has <c>maxResults</c> of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a <c>nextToken</c>. Using the next token in a subsequent call will return the remaining 2 namespaces.</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="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperCmdlet"> <summary> The <c>DescribeScraper</c> operation displays information about an existing scraper. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperCmdlet.ScraperId"> <summary> <para> <para>The ID 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="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet"> <summary> The <c>ListScrapers</c> operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet.Filter"> <summary> <para> <para>(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include <c>status</c>, <c>sourceArn</c>, <c>destinationArn</c>, and <c>alias</c>.</para><para>Filters on the same key are <c>OR</c>'d together, and filters on different keys are <c>AND</c>'d together. For example, <c>status=ACTIVE&status=CREATING&alias=Test</c>, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.</para><para>To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:</para><para><c>status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012</c></para><para>If this is included, it filters the results to only the scrapers that match the filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet.MaxResult"> <summary> <para> <para>Optional) The maximum number of scrapers to return in one <c>ListScrapers</c> operation. The range is 1-1000.</para><para>If you omit this parameter, the default of 100 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMScraperListCmdlet.NextToken"> <summary> <para> <para>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</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> Returns information about an existing 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="T:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet"> <summary> Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet.Alias"> <summary> <para> <para>If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.</para><para>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of workspaces to return per request. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.GetPROMWorkspaceListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.</para><para>For example, if your initial request has <c>maxResults</c> of 10, and there are 12 workspaces to return, then your initial request will return 10 and a <c>nextToken</c>. Using the next token in a subsequent call will return the remaining 2 workspaces.</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="T:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet"> <summary> The <c>CreateAlertManagerDefinition</c> operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use <c>PutAlertManagerDefinition</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet.Data"> <summary> <para> <para>The alert manager definition to add. A base64-encoded version of the YAML alert manager definition file.</para><para>For details about the alert manager definition, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html">AlertManagedDefinitionData</a>.</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 to add the alert manager definition to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMAlertManagerDefinitionCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> The <c>CreateLoggingConfiguration</c> operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.LogGroupArn"> <summary> <para> <para>The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to create the logging configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMLoggingConfigurationCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> The <c>CreateRuleGroupsNamespace</c> operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. <para> Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use <c>PutRuleGroupsNamespace</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.Data"> <summary> <para> <para>The rules file to use in the new namespace.</para><para>Contains the base64-encoded version of the YAML rules file.</para><para>For details about the rule groups namespace structure, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html">RuleGroupsNamespaceData</a>.</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 name for the new rule groups namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.Tag"> <summary> <para> <para>The list of tag keys and values to associate with the rule groups namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to add the rule groups namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMRuleGroupsNamespaceCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> The <c>CreateScraper</c> operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace. <para> If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper">Using roles for scraping metrics from EKS</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>. </para><para> You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one. </para><para> The <c>scrapeConfiguration</c> parameter contains the base64-encoded version of the YAML configuration file. </para><note><para> For more information about collectors, including what metrics are collected, and how to configure the scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html">Amazon Web Services managed collectors</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.Alias"> <summary> <para> <para>(optional) a name to associate with the scraper. This is for your use, and does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.EksConfiguration_ClusterArn"> <summary> <para> <para>ARN of the Amazon EKS cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.ScrapeConfiguration_ConfigurationBlob"> <summary> <para> <para>The base 64 encoded scrape 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 the security group IDs for the Amazon EKS cluster VPC configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.EksConfiguration_SubnetId"> <summary> <para> <para>A list of subnet IDs for the Amazon EKS cluster VPC configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.Tag"> <summary> <para> <para>(Optional) The list of tag keys and values to associate with the scraper.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.AmpConfiguration_WorkspaceArn"> <summary> <para> <para>ARN of the Amazon Managed Service for Prometheus workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMScraperCmdlet.ClientToken"> <summary> <para> <para>(Optional) A unique, case-sensitive identifier that you can provide 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.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 Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.Alias"> <summary> <para> <para>An alias that you assign to this workspace to help you identify it. It does not need to be unique.</para><para>Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.KmsKeyArn"> <summary> <para> <para>(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html">Encryption at rest</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.Tag"> <summary> <para> <para>The list of tag keys and values to associate with the workspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.NewPROMWorkspaceCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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 the alert manager definition from a workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMAlertManagerDefinitionCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to delete the alert manager definition from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMAlertManagerDefinitionCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> Deletes the logging configuration for a workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMLoggingConfigurationCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace containing the logging configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMLoggingConfigurationCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the workspace or rule groups namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove.</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.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> Deletes one rule groups namespace and its associated rule groups definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.Name"> <summary> <para> <para>The name of the rule groups namespace to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace containing the rule groups namespace and definition to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.RemovePROMRuleGroupsNamespaceCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> The <c>DeleteScraper</c> operation deletes one scraper, and stops any metrics collection that the scraper performs. </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) A unique, case-sensitive identifier that you can provide 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.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 existing workspace. <note><para> When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month. </para></note> </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>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> Updates the log group ARN or the workspace ID of the current logging configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMLoggingConfigurationCmdlet.LogGroupArn"> <summary> <para> <para>The ARN of the CloudWatch 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 update the logging configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMLoggingConfigurationCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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 the alias of an existing workspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.Alias"> <summary> <para> <para>The new alias for the workspace. It does not need to be unique.</para><para>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.UpdatePROMWorkspaceAliasCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use <c>CreateAlertManagerDefinition</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMAlertManagerDefinitionCmdlet.Data"> <summary> <para> <para>The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.</para><para>For details about the alert manager definition, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html">AlertManagedDefinitionData</a>.</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 to update the alert manager definition in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMAlertManagerDefinitionCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. <para> Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use <c>CreateRuleGroupsNamespace</c>. </para><para> You can't use this operation to add tags to an existing rule groups namespace. Instead, use <c>TagResource</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.Data"> <summary> <para> <para>The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.</para><para>For details about the rule groups namespace structure, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html">RuleGroupsNamespaceData</a>.</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 name of the rule groups namespace that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.WorkspaceId"> <summary> <para> <para>The ID of the workspace where you are updating the rule groups namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PROM.WritePROMRuleGroupsNamespaceCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</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.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> |