AWS.Tools.CloudWatchLogs.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudWatchLogs</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CWL.AddCWLLogGroupTagCmdlet"> <summary> <important><para> The TagLogGroup operation is on the path to deprecation. We recommend that you use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a> instead. </para></important><para> Adds or updates the specified tags for the specified log group. </para><para> To list the tags for a log group, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>. To remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>. </para><para> For more information about tags, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging">Tag Log Groups in Amazon CloudWatch Logs</a> in the <i>Amazon CloudWatch Logs User Guide</i>. </para><para> CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to log groups using the <c>aws:Resource/<i>key-name</i></c> or <c>aws:TagKeys</c> condition keys. For more information about using tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLLogGroupTagCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLLogGroupTagCmdlet.Tag"> <summary> <para> <para>The key-value pairs to use for the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLLogGroupTagCmdlet.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.CloudWatchLogs.Model.TagLogGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLLogGroupTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLLogGroupTagCmdlet.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.CWL.AddCWLResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations. <para> Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. </para><para> Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. </para><para> You can use the <c>TagResource</c> action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. </para><para> You can associate as many as 50 tags with a CloudWatch Logs resource. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource that you're adding tags to.</para><para>The ARN format of a log group is <c>arn:aws:logs:<i>Region</i>:<i>account-id</i>:log-group:<i>log-group-name</i></c></para><para>The ARN format of a destination is <c>arn:aws:logs:<i>Region</i>:<i>account-id</i>:destination:<i>destination-name</i></c></para><para>For more information about ARN format, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html">CloudWatch Logs resources and operations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLResourceTagCmdlet.Tag"> <summary> <para> <para>The list of key-value pairs to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLResourceTagCmdlet.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.CloudWatchLogs.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.AddCWLResourceTagCmdlet.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.CWL.AddCWLResourceTagCmdlet.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.CWL.FindCWLConfigurationTemplateCmdlet"> <summary> Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.DeliveryDestinationType"> <summary> <para> <para>Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.LogType"> <summary> <para> <para>Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.ResourceType"> <summary> <para> <para>Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.Service"> <summary> <para> <para>Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.Limit"> <summary> <para> <para>Use this parameter to limit the number of configuration templates that are returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationTemplates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeConfigurationTemplatesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeConfigurationTemplatesResponse 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.CWL.FindCWLConfigurationTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Service parameter. The -PassThru parameter is deprecated, use -Select '^Service' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLConfigurationTemplateCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryCmdlet"> <summary> Retrieves a list of the deliveries that have been created in the account. <para> A <i>delivery</i> is a connection between a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html"><i>delivery source</i></a> and a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html"><i>delivery destination</i></a>. </para><para> A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services services.</a></para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryCmdlet.Limit"> <summary> <para> <para>Optionally specify the maximum number of deliveries to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Deliveries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeDeliveriesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeDeliveriesResponse 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.CWL.FindCWLDeliveryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryDestinationCmdlet"> <summary> Retrieves a list of the delivery destinations that have been created in the account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryDestinationCmdlet.Limit"> <summary> <para> <para>Optionally specify the maximum number of delivery destinations to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryDestinationCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliveryDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliveryDestinations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeDeliveryDestinationsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeDeliveryDestinationsResponse 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.CWL.FindCWLDeliveryDestinationCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliverySourceCmdlet"> <summary> Retrieves a list of the delivery sources that have been created in the account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliverySourceCmdlet.Limit"> <summary> <para> <para>Optionally specify the maximum number of delivery sources to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliverySourceCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.FindCWLDeliverySourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliverySources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeDeliverySourcesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeDeliverySourcesResponse 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.CWL.FindCWLDeliverySourceCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLAccountPolicyCmdlet"> <summary> Returns a list of all CloudWatch Logs account policies in the account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAccountPolicyCmdlet.AccountIdentifier"> <summary> <para> <para>If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.</para><para>If you omit this parameter, only the policy in the current account is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAccountPolicyCmdlet.PolicyName"> <summary> <para> <para>Use this parameter to limit the returned policies to only the policy with the name that you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAccountPolicyCmdlet.PolicyType"> <summary> <para> <para>Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAccountPolicyCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAccountPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountPolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeAccountPoliciesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeAccountPoliciesResponse 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.CWL.GetCWLAccountPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyType parameter. The -PassThru parameter is deprecated, use -Select '^PolicyType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAccountPolicyCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLAnomalyListCmdlet"> <summary> Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAnomalyListCmdlet.AnomalyDetectorArn"> <summary> <para> <para>Use this to optionally limit the results to only the anomalies found by a certain anomaly detector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAnomalyListCmdlet.SuppressionState"> <summary> <para> <para>You can specify this parameter if you want to the operation to return only anomalies that are currently either suppressed or unsuppressed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAnomalyListCmdlet.Limit"> <summary> <para> <para>The maximum number of items to return. If you don't specify a value, the default maximum value of 50 items is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAnomalyListCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLAnomalyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Anomalies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.ListAnomaliesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.ListAnomaliesResponse 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.CWL.GetCWLAnomalyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLDataProtectionPolicyCmdlet"> <summary> Returns information about a log group data protection policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDataProtectionPolicyCmdlet.LogGroupIdentifier"> <summary> <para> <para>The name or ARN of the log group that contains the data protection policy that you want to see.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDataProtectionPolicyCmdlet.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.CloudWatchLogs.Model.GetDataProtectionPolicyResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetDataProtectionPolicyResponse 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.CWL.GetCWLDataProtectionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryCmdlet"> <summary> Returns complete information about one logical <i>delivery</i>. A delivery is a connection between a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html"><i>delivery source</i></a> and a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html"><i>delivery destination</i></a>. <para> A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services services.</a></para><para> You need to specify the delivery <c>id</c> in this operation. You can find the IDs of the deliveries in your account with the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryCmdlet.Id"> <summary> <para> <para>The ID of the delivery that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Delivery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.GetDeliveryResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetDeliveryResponse 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.CWL.GetCWLDeliveryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryDestinationCmdlet"> <summary> Retrieves complete information about one delivery destination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryDestinationCmdlet.Name"> <summary> <para> <para>The name of the delivery destination that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliveryDestination'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.GetDeliveryDestinationResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetDeliveryDestinationResponse 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.CWL.GetCWLDeliveryDestinationCmdlet.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.CWL.GetCWLDeliveryDestinationPolicyCmdlet"> <summary> Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryDestinationPolicyCmdlet.DeliveryDestinationName"> <summary> <para> <para>The name of the delivery destination that you want to retrieve the policy of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliveryDestinationPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.GetDeliveryDestinationPolicyResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetDeliveryDestinationPolicyResponse 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.CWL.GetCWLDeliveryDestinationPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryDestinationName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryDestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliverySourceCmdlet"> <summary> Retrieves complete information about one delivery source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliverySourceCmdlet.Name"> <summary> <para> <para>The name of the delivery source that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDeliverySourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliverySource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.GetDeliverySourceResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetDeliverySourceResponse 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.CWL.GetCWLDeliverySourceCmdlet.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.CWL.GetCWLDestinationCmdlet"> <summary> Lists all your destinations. The results are ASCII-sorted by destination name.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.DestinationNamePrefix"> <summary> <para> <para>The prefix to match. If you don't specify a value, no prefix filter is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.Limit"> <summary> <para> <para>The maximum number of items returned. If you don't specify a value, the default maximum value of 50 items is used.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Destinations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeDestinationsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeDestinationsResponse 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.CWL.GetCWLDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DestinationNamePrefix parameter. The -PassThru parameter is deprecated, use -Select '^DestinationNamePrefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTaskCmdlet"> <summary> Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTaskCmdlet.StatusCode"> <summary> <para> <para>The status code of the export task. Specifying a status code filters the results to zero or more export tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTaskCmdlet.TaskId"> <summary> <para> <para>The ID of the export task. Specifying a task ID filters the results to one or zero export tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTaskCmdlet.Limit"> <summary> <para> <para>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTaskCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportTasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeExportTasksResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeExportTasksResponse 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.CWL.GetCWLExportTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTaskCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLFieldIndexCmdlet"> <summary> Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFieldIndexCmdlet.LogGroupIdentifier"> <summary> <para> <para>An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFieldIndexCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFieldIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldIndexes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeFieldIndexesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeFieldIndexesResponse 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.CWL.GetCWLFieldIndexCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet"> <summary> Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. <para> You must have the <c>logs:FilterLogEvents</c> permission to perform this operation. </para><para> You can specify the log group to search by using either <c>logGroupIdentifier</c> or <c>logGroupName</c>. You must include one of these two parameters, but you can't include both. </para><para> By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token. </para><para> The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the <c>PutLogEvents</c> request. </para><para> If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. </para><br/><br/>In the AWS.Tools.CloudWatchLogs module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.EndTime"> <summary> <para> <para>The end of the time range, expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. Events with a timestamp later than this time are not returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.FilterPattern"> <summary> <para> <para>The filter pattern to use. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</para><para>If not provided, all the events are matched.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to search.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.LogStreamNamePrefix"> <summary> <para> <para>Filters the results to include only events from log streams that have names starting with this prefix.</para><para>If you specify a value for both <c>logStreamNamePrefix</c> and <c>logStreamNames</c>, the action returns an <c>InvalidParameterException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.LogStreamName"> <summary> <para> <para>Filters the results to only logs from the log streams in this list.</para><para>If you specify a value for both <c>logStreamNames</c> and <c>logStreamNamePrefix</c>, the action returns an <c>InvalidParameterException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.StartTime"> <summary> <para> <para>The start of the time range, expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. Events with a timestamp before this time are not returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.Unmask"> <summary> <para> <para>Specify <c>true</c> to display the log event fields with all sensitive data unmasked and visible. The default is <c>false</c>.</para><para>To use this operation with this parameter, you must be signed into an account with the <c>logs:Unmask</c> permission.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.Interleaved"> <summary> <para> <para>If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.</para><para><b>Important</b> As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.Limit"> <summary> <para> <para>The maximum number of events to return. The default is 10,000 events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.NextToken"> <summary> <para> <para>The token for the next set of events to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.CloudWatchLogs module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.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.CloudWatchLogs.Model.FilterLogEventsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.FilterLogEventsResponse 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.CWL.GetCWLFilteredLogEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLIndexPolicyCmdlet"> <summary> Returns the field index policies of one or more log groups. For more information about field index policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a>. <para> If a specified log group has a log-group level index policy, that policy is returned by this operation. </para><para> If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation. </para><para> To find information about only account-level policies, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeAccountPolicies.html">DescribeAccountPolicies</a> instead. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIndexPolicyCmdlet.LogGroupIdentifier"> <summary> <para> <para>An array containing the name or ARN of the log group that you want to retrieve field index policies for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIndexPolicyCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIndexPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndexPolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeIndexPoliciesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeIndexPoliciesResponse 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.CWL.GetCWLIndexPolicyCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationCmdlet"> <summary> Returns information about one integration between CloudWatch Logs and OpenSearch Service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationCmdlet.IntegrationName"> <summary> <para> <para>The name of the integration that you want to find information about. To find the name of your integration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html">ListIntegrations</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationCmdlet.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.CloudWatchLogs.Model.GetIntegrationResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetIntegrationResponse 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.CWL.GetCWLIntegrationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IntegrationName parameter. The -PassThru parameter is deprecated, use -Select '^IntegrationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationListCmdlet"> <summary> Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationListCmdlet.IntegrationNamePrefix"> <summary> <para> <para>To limit the results to integrations that start with a certain name prefix, specify that name prefix here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationListCmdlet.IntegrationStatus"> <summary> <para> <para>To limit the results to integrations with a certain status, specify that status here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationListCmdlet.IntegrationType"> <summary> <para> <para>To limit the results to integrations of a certain type, specify that type here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLIntegrationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IntegrationSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.ListIntegrationsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.ListIntegrationsResponse 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.CWL.GetCWLLogAnomalyDetectorCmdlet"> <summary> Retrieves information about the log anomaly detector that you specify. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorCmdlet.AnomalyDetectorArn"> <summary> <para> <para>The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors in your account by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html">ListLogAnomalyDetectors</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorCmdlet.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.CloudWatchLogs.Model.GetLogAnomalyDetectorResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetLogAnomalyDetectorResponse 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.CWL.GetCWLLogAnomalyDetectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnomalyDetectorArn parameter. The -PassThru parameter is deprecated, use -Select '^AnomalyDetectorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorListCmdlet"> <summary> Retrieves a list of the log anomaly detectors in the account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorListCmdlet.FilterLogGroupArn"> <summary> <para> <para>Use this to optionally filter the results to only include anomaly detectors that are associated with the specified log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorListCmdlet.Limit"> <summary> <para> <para>The maximum number of items to return. If you don't specify a value, the default maximum value of 50 items is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorListCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AnomalyDetectors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.ListLogAnomalyDetectorsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.ListLogAnomalyDetectorsResponse 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.CWL.GetCWLLogAnomalyDetectorListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FilterLogGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^FilterLogGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogAnomalyDetectorListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet"> <summary> Lists log events from the specified log stream. You can list all of the log events or filter using a time range. <para> By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token. </para><para> If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. </para><para> You can specify the log group to search by using either <c>logGroupIdentifier</c> or <c>logGroupName</c>. You must include one of these two parameters, but you can't include both. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.EndTime"> <summary> <para> <para>The end of the time range, expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. Events with a timestamp equal to or later than this time are not included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.StartFromHead"> <summary> <para> <para>If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.</para><para>If you are using a previous <c>nextForwardToken</c> value as the <c>nextToken</c> in this operation, you must specify <c>true</c> for <c>startFromHead</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.StartTime"> <summary> <para> <para>The start of the time range, expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.Unmask"> <summary> <para> <para>Specify <c>true</c> to display the log event fields with all sensitive data unmasked and visible. The default is <c>false</c>.</para><para>To use this operation with this parameter, you must be signed into an account with the <c>logs:Unmask</c> permission.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.Limit"> <summary> <para> <para>The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventCmdlet.NextToken"> <summary> <para> <para>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.CWL.GetCWLLogEventCmdlet.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.CloudWatchLogs.Model.GetLogEventsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetLogEventsResponse 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.CWL.GetCWLLogEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogStreamName parameter. The -PassThru parameter is deprecated, use -Select '^LogStreamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet"> <summary> Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. <para> CloudWatch Logs doesn't support IAM policies that control access to the <c>DescribeLogGroups</c> action by using the <c>aws:ResourceTag/<i>key-name</i></c> condition key. Other CloudWatch Logs actions do support the use of the <c>aws:ResourceTag/<i>key-name</i></c> condition key to control access. For more information about using tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>. </para><para> If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.AccountIdentifier"> <summary> <para> <para>When <c>includeLinkedAccounts</c> is set to <c>True</c>, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.IncludeLinkedAccount"> <summary> <para> <para>If you are using a monitoring account, set this to <c>True</c> to have the operation return log groups in the accounts listed in <c>accountIdentifiers</c>.</para><para>If this parameter is set to <c>true</c> and <c>accountIdentifiers</c> contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.LogGroupClass"> <summary> <para> <para>Specifies the log group class for this log group. There are two classes:</para><ul><li><para>The <c>Standard</c> log class supports all CloudWatch Logs features.</para></li><li><para>The <c>Infrequent Access</c> log class supports a subset of CloudWatch Logs features and incurs lower costs.</para></li></ul><para>For details about the features supported by each class, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.LogGroupNamePattern"> <summary> <para> <para>If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify <c>Foo</c>, log groups named <c>FooBar</c>, <c>aws/Foo</c>, and <c>GroupFoo</c> would match, but <c>foo</c>, <c>F/o/o</c> and <c>Froo</c> would not match.</para><para>If you specify <c>logGroupNamePattern</c> in your request, then only <c>arn</c>, <c>creationTime</c>, and <c>logGroupName</c> are included in the response. </para><note><para><c>logGroupNamePattern</c> and <c>logGroupNamePrefix</c> are mutually exclusive. Only one of these parameters can be passed. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.LogGroupNamePrefix"> <summary> <para> <para>The prefix to match.</para><note><para><c>logGroupNamePrefix</c> and <c>logGroupNamePattern</c> are mutually exclusive. Only one of these parameters can be passed. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.Limit"> <summary> <para> <para>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LogGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeLogGroupsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeLogGroupsResponse 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.CWL.GetCWLLogGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupNamePrefix parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupNamePrefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupFieldCmdlet"> <summary> Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify. <para> You can specify the log group to search by using either <c>logGroupIdentifier</c> or <c>logGroupName</c>. You must specify one of these parameters, but you can't specify both. </para><para> In the results, fields that start with <c>@</c> are fields generated by CloudWatch Logs. For example, <c>@timestamp</c> is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html">Supported Logs and Discovered Fields</a>. </para><para> The response results are sorted by the frequency percentage, starting with the highest percentage. </para><para> If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupFieldCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupFieldCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to search.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupFieldCmdlet.Time"> <summary> <para> <para>The time to set as the center of the query. If you specify <c>time</c>, the 8 minutes before and 8 minutes after this time are searched. If you omit <c>time</c>, the most recent 15 minutes up to the current time are searched.</para><para>The <c>time</c> value is specified as epoch time, which is the number of seconds since <c>January 1, 1970, 00:00:00 UTC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupFieldCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LogGroupFields'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.GetLogGroupFieldsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetLogGroupFieldsResponse 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.CWL.GetCWLLogGroupFieldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsForQueryListCmdlet"> <summary> Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries that use log group name prefixes or the <c>filterIndex</c> command, because the log groups are dynamically selected in these cases. <para> For more information about field indexes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html">Create field indexes to improve query performance and reduce costs</a>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsForQueryListCmdlet.QueryId"> <summary> <para> <para>The ID of the query to use. This query ID is from the response to your <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsForQueryListCmdlet.MaxResult"> <summary> <para> <para>Limits the number of returned log groups to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsForQueryListCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsForQueryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LogGroupIdentifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.ListLogGroupsForQueryResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.ListLogGroupsForQueryResponse 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.CWL.GetCWLLogGroupsForQueryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsForQueryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupTagCmdlet"> <summary> <important><para> The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> instead. </para></important><para> Lists the tags for the specified log group. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupTagCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupTagCmdlet.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.CloudWatchLogs.Model.ListTagsLogGroupResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.ListTagsLogGroupResponse 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.CWL.GetCWLLogGroupTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogRecordCmdlet"> <summary> Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the <c>logRecordPointer</c> retrieved only a subset of fields. Fields are returned as field name/field value pairs. <para> The full unparsed log event is returned within <c>@message</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogRecordCmdlet.LogRecordPointer"> <summary> <para> <para>The pointer corresponding to the log event record you want to retrieve. You get this from the response of a <c>GetQueryResults</c> operation. In that response, the value of the <c>@ptr</c> field for a log event is the value to use as <c>logRecordPointer</c> to retrieve that complete log event record.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogRecordCmdlet.Unmask"> <summary> <para> <para>Specify <c>true</c> to display the log event fields with all sensitive data unmasked and visible. The default is <c>false</c>.</para><para>To use this operation with this parameter, you must be signed into an account with the <c>logs:Unmask</c> permission.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogRecordCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LogRecord'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.GetLogRecordResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetLogRecordResponse 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.CWL.GetCWLLogRecordCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogRecordPointer parameter. The -PassThru parameter is deprecated, use -Select '^LogRecordPointer' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet"> <summary> Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. <para> You can specify the log group to search by using either <c>logGroupIdentifier</c> or <c>logGroupName</c>. You must include one of these two parameters, but you can't include both. </para><para> This operation has a limit of five transactions per second, after which transactions are throttled. </para><para> If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.Descending"> <summary> <para> <para>If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para><note><para> You must include either <c>logGroupIdentifier</c> or <c>logGroupName</c>, but not both. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.LogStreamNamePrefix"> <summary> <para> <para>The prefix to match.</para><para>If <c>orderBy</c> is <c>LastEventTime</c>, you cannot specify this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.OrderBy"> <summary> <para> <para>If the value is <c>LogStreamName</c>, the results are ordered by log stream name. If the value is <c>LastEventTime</c>, the results are ordered by the event time. The default value is <c>LogStreamName</c>.</para><para>If you order the results by event time, you cannot specify the <c>logStreamNamePrefix</c> parameter.</para><para><c>lastEventTimestamp</c> represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. <c>lastEventTimestamp</c> updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.Limit"> <summary> <para> <para>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LogStreams'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeLogStreamsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeLogStreamsResponse 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.CWL.GetCWLLogStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet"> <summary> Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.FilterNamePrefix"> <summary> <para> <para>The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the <c>logGroupName</c> parameter in your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.MetricName"> <summary> <para> <para>Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the <c>metricNamespace</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.MetricNamespace"> <summary> <para> <para>Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the <c>metricName</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.Limit"> <summary> <para> <para>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricFilters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResponse 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.CWL.GetCWLMetricFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFilterCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet"> <summary> Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet.LogGroupName"> <summary> <para> <para>Limits the returned queries to only those for the specified log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet.QueryLanguage"> <summary> <para> <para>Limits the returned queries to only the queries that use the specified query language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet.Status"> <summary> <para> <para>Limits the returned queries to only those that have the specified status. Valid values are <c>Cancelled</c>, <c>Complete</c>, <c>Failed</c>, <c>Running</c>, and <c>Scheduled</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet.MaxResult"> <summary> <para> <para>Limits the number of returned queries to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Queries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeQueriesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeQueriesResponse 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.CWL.GetCWLQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryDefinitionCmdlet"> <summary> This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account. <para> You can use the <c>queryDefinitionNamePrefix</c> parameter to limit the results to only the query definitions that have names that start with a certain string. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryDefinitionCmdlet.QueryDefinitionNamePrefix"> <summary> <para> <para>Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryDefinitionCmdlet.QueryLanguage"> <summary> <para> <para>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryDefinitionCmdlet.MaxResult"> <summary> <para> <para>Limits the number of returned query definitions to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryDefinitionCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryDefinitions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeQueryDefinitionsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeQueryDefinitionsResponse 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.CWL.GetCWLQueryDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryDefinitionNamePrefix parameter. The -PassThru parameter is deprecated, use -Select '^QueryDefinitionNamePrefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryDefinitionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryResultCmdlet"> <summary> Returns the results from the specified query. <para> Only the fields requested in the query are returned, along with a <c>@ptr</c> field, which is the identifier for the log record. You can use the value of <c>@ptr</c> in a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html">GetLogRecord</a> operation to get the full log record. </para><para><c>GetQueryResults</c> does not start running a query. To run a query, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a>. For more information about how long results of previous queries are available, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html">CloudWatch Logs quotas</a>. </para><para> If the value of the <c>Status</c> field in the output is <c>Running</c>, this operation returns only partial results. If you see a value of <c>Scheduled</c> or <c>Running</c> for the status, you can retry the operation later to see the final results. </para><para> If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryResultCmdlet.QueryId"> <summary> <para> <para>The ID number of the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLQueryResultCmdlet.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.CloudWatchLogs.Model.GetQueryResultsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetQueryResultsResponse 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.CWL.GetCWLQueryResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLResourcePolicyCmdlet"> <summary> Lists the resource policies in this account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLResourcePolicyCmdlet.Limit"> <summary> <para> <para>The maximum number of resource policies to be displayed with one call of this API.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLResourcePolicyCmdlet.NextToken"> <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> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeResourcePoliciesResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeResourcePoliciesResponse 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.CWL.GetCWLResourcePolicyCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLResourceTagCmdlet"> <summary> Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource that you want to view tags for.</para><para>The ARN format of a log group is <c>arn:aws:logs:<i>Region</i>:<i>account-id</i>:log-group:<i>log-group-name</i></c></para><para>The ARN format of a destination is <c>arn:aws:logs:<i>Region</i>:<i>account-id</i>:destination:<i>destination-name</i></c></para><para>For more information about ARN format, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html">CloudWatch Logs resources and operations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLResourceTagCmdlet.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.CloudWatchLogs.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.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.CWL.GetCWLResourceTagCmdlet.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.CWL.GetCWLSubscriptionFilterCmdlet"> <summary> Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFilterCmdlet.FilterNamePrefix"> <summary> <para> <para>The prefix to match. If you don't specify a value, no prefix filter is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFilterCmdlet.Limit"> <summary> <para> <para>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFilterCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SubscriptionFilters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResponse 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.CWL.GetCWLSubscriptionFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFilterCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLTransformerCmdlet"> <summary> Returns the information about the log transformer associated with this log group. <para> This operation returns data only for transformers created at the log group level. To get information for an account-level transformer, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeAccountPolicies.html">DescribeAccountPolicies</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLTransformerCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the name or ARN of the log group to return transformer information for. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLTransformerCmdlet.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.CloudWatchLogs.Model.GetTransformerResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.GetTransformerResponse 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.CWL.GetCWLTransformerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet"> <summary> Creates a <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical <i>delivery destination</i> that you have already created. <para> Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as <b>Supported [V2 Permissions]</b> in the table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from Amazon Web Services services.</a></para><para> A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose. </para><para> To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following: </para><ul><li><para> Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>. </para></li><li><para> Create a <i>delivery destination</i>, which is a logical object that represents the actual delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">PutDeliveryDestination</a>. </para></li><li><para> If you are delivering logs cross-account, you must use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a> in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. </para></li><li><para> Use <c>CreateDelivery</c> to create a <i>delivery</i> by pairing exactly one delivery source and one delivery destination. </para></li></ul><para> You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination. </para><para> To update an existing delivery configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.DeliveryDestinationArn"> <summary> <para> <para>The ARN of the delivery destination to use for this delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.DeliverySourceName"> <summary> <para> <para>The name of the delivery source to use for this delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.S3DeliveryConfiguration_EnableHiveCompatiblePath"> <summary> <para> <para>This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.FieldDelimiter"> <summary> <para> <para>The field delimiter to use between record fields when the final output format of a delivery is in <c>Plain</c>, <c>W3C</c>, or <c>Raw</c> format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.RecordField"> <summary> <para> <para>The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.S3DeliveryConfiguration_SuffixPath"> <summary> <para> <para>This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.Tag"> <summary> <para> <para>An optional list of key-value pairs to associate with the resource.</para><para>For more information about tagging, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLDeliveryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Delivery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.CreateDeliveryResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.CreateDeliveryResponse 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.CWL.NewCWLDeliveryCmdlet.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.CWL.NewCWLExportTaskCmdlet"> <summary> Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a <c>CreateExportTask</c> operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination. <para> Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported. </para><para> Exporting to S3 buckets that are encrypted with AES-256 is supported. </para><para> This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html">DescribeExportTasks</a> to get the status of the export task. Each account can only have one active (<c>RUNNING</c> or <c>PENDING</c>) export task at a time. To cancel an export task, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html">CancelExportTask</a>. </para><para> You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects. </para><note><para> Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.Destination"> <summary> <para> <para>The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.DestinationPrefix"> <summary> <para> <para>The prefix used as the start of the key for every object exported. If you don't specify a value, the default is <c>exportedlogs</c>.</para><para>The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding, and can be up to 1,024 bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.From"> <summary> <para> <para>The start time of the range for the request, expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. Events with a timestamp earlier than this time are not exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.LogStreamNamePrefix"> <summary> <para> <para>Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.TaskName"> <summary> <para> <para>The name of the export task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.To"> <summary> <para> <para>The end time of the range for the request, expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. Events with a timestamp later than this time are not exported.</para><para>You must specify a time that is not earlier than when this log group was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TaskId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.CreateExportTaskResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.CreateExportTaskResponse 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.CWL.NewCWLExportTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.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.CWL.NewCWLLogAnomalyDetectorCmdlet"> <summary> Creates an <i>anomaly detector</i> that regularly scans one or more log groups and look for patterns and anomalies in the logs. <para> An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find <i>patterns</i>. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns. </para><para> The anomaly detector uses pattern recognition to find <c>anomalies</c>, which are unusual log events. It uses the <c>evaluationFrequency</c> to compare current log events and patterns with trained baselines. </para><para> Fields within a pattern are called <i>tokens</i>. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as <i>dynamic tokens</i> and represented by <c><*></c>. </para><para> The following is an example of a pattern: </para><para><c>[INFO] Request time: <*> ms</c></para><para> This pattern represents log events like <c>[INFO] Request time: 327 ms</c> and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by <c><*></c></para><note><para> Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Help protect sensitive log data with masking</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.AnomalyVisibilityTime"> <summary> <para> <para>The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in <c>anomalyVisibilityTime</c>, it will be considered normal going forward and will not be detected as an anomaly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.DetectorName"> <summary> <para> <para>A name for this anomaly detector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.EvaluationFrequency"> <summary> <para> <para>Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for <c>evaluationFrequency</c> .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.FilterPattern"> <summary> <para> <para>You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.KmsKeyId"> <summary> <para> <para>Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds.</para><para>For more information about using a KMS key and to see the required IAM policy, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html">Use a KMS key with an anomaly detector</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.LogGroupArnList"> <summary> <para> <para>An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.Tag"> <summary> <para> <para>An optional list of key-value pairs to associate with the resource.</para><para>For more information about tagging, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogAnomalyDetectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AnomalyDetectorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.CreateLogAnomalyDetectorResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.CreateLogAnomalyDetectorResponse 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.CWL.NewCWLLogAnomalyDetectorCmdlet.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.CWL.NewCWLLogGroupCmdlet"> <summary> Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account. <para> You must use the following guidelines when naming a log group: </para><ul><li><para> Log group names must be unique within a Region for an Amazon Web Services account. </para></li><li><para> Log group names can be between 1 and 512 characters long. </para></li><li><para> Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign) </para></li><li><para> Log group names can't start with the string <c>aws/</c></para></li></ul><para> When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html">PutRetentionPolicy</a>. </para><para> If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. </para><para> If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an <c>InvalidParameterException</c> error. </para><important><para> CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric Keys</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Amazon Resource Names</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.LogGroupClass"> <summary> <para> <para>Use this parameter to specify the log group class for this log group. There are two classes:</para><ul><li><para>The <c>Standard</c> log class supports all CloudWatch Logs features.</para></li><li><para>The <c>Infrequent Access</c> log class supports a subset of CloudWatch Logs features and incurs lower costs.</para></li></ul><para>If you omit this parameter, the default of <c>STANDARD</c> is used.</para><important><para>The value of <c>logGroupClass</c> can't be changed after a log group is created.</para></important><para>For details about the features supported by each class, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.LogGroupName"> <summary> <para> <para>A name for the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.Tag"> <summary> <para> <para>The key-value pairs to use for the tags.</para><para>You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the <c>logs:TagResource</c> or <c>logs:TagLogGroup</c> permission. For more information about tagging, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>. For more information about using tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.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.CloudWatchLogs.Model.CreateLogGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.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.CWL.NewCWLLogStreamCmdlet"> <summary> Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored. <para> There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on <c>CreateLogStream</c> operations, after which transactions are throttled. </para><para> You must use the following guidelines when naming a log stream: </para><ul><li><para> Log stream names must be unique within the log group. </para></li><li><para> Log stream names can be between 1 and 512 characters long. </para></li><li><para> Don't use ':' (colon) or '*' (asterisk) characters. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.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.CloudWatchLogs.Model.CreateLogStreamResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.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.CWL.RegisterCWLKmsKeyCmdlet"> <summary> Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account. <para> When you use <c>AssociateKmsKey</c>, you specify either the <c>logGroupName</c> parameter or the <c>resourceIdentifier</c> parameter. You can't specify both of those parameters in the same operation. </para><ul><li><para> Specify the <c>logGroupName</c> parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key. </para><para> Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. </para><para> Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an <c>AssociateKmsKey</c> operation with the <c>resourceIdentifier</c> parameter that specifies a <c>query-result</c> resource. </para></li><li><para> Specify the <c>resourceIdentifier</c> parameter with a <c>query-result</c> resource, to use that key to encrypt the stored results of all future <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> operations in the account. The response from a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html">GetQueryResults</a> operation will still return the query results in plain text. </para><para> Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method. </para><para> If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used. </para></li></ul><important><para> If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable. </para></important><note><para> CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric Keys</a>. </para></note><para> It can take up to 5 minutes for this operation to take effect. </para><para> If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an <c>InvalidParameterException</c> error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RegisterCWLKmsKeyCmdlet.KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Amazon Resource Names</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric Keys</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RegisterCWLKmsKeyCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para><para>In your <c>AssociateKmsKey</c> operation, you must specify either the <c>resourceIdentifier</c> parameter or the <c>logGroup</c> parameter, but you can't specify both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RegisterCWLKmsKeyCmdlet.ResourceIdentifier"> <summary> <para> <para>Specifies the target for this operation. You must specify one of the following:</para><ul><li><para>Specify the following ARN to have future <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html">GetQueryResults</a> operations in this account encrypt the results with the specified KMS key. Replace <i>REGION</i> and <i>ACCOUNT_ID</i> with your Region and account ID.</para><para><c>arn:aws:logs:<i>REGION</i>:<i>ACCOUNT_ID</i>:query-result:*</c></para></li><li><para>Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. The log group ARN must be in the following format. Replace <i>REGION</i> and <i>ACCOUNT_ID</i> with your Region and account ID.</para><para><c>arn:aws:logs:<i>REGION</i>:<i>ACCOUNT_ID</i>:log-group:<i>LOG_GROUP_NAME</i></c></para></li></ul><para>In your <c>AssociateKmsKey</c> operation, you must specify either the <c>resourceIdentifier</c> parameter or the <c>logGroup</c> parameter, but you can't specify both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RegisterCWLKmsKeyCmdlet.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.CloudWatchLogs.Model.AssociateKmsKeyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RegisterCWLKmsKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KmsKeyId parameter. The -PassThru parameter is deprecated, use -Select '^KmsKeyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RegisterCWLKmsKeyCmdlet.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.CWL.RemoveCWLAccountPolicyCmdlet"> <summary> Deletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups in the account. If you delete a data protection policy or subscription filter policy, any log-group level policies of those types remain in effect. <para> To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting. </para><ul><li><para> To delete a data protection policy, you must have the <c>logs:DeleteDataProtectionPolicy</c> and <c>logs:DeleteAccountPolicy</c> permissions. </para></li><li><para> To delete a subscription filter policy, you must have the <c>logs:DeleteSubscriptionFilter</c> and <c>logs:DeleteAccountPolicy</c> permissions. </para></li><li><para> To delete a transformer policy, you must have the <c>logs:DeleteTransformer</c> and <c>logs:DeleteAccountPolicy</c> permissions. </para></li><li><para> To delete a field index policy, you must have the <c>logs:DeleteIndexPolicy</c> and <c>logs:DeleteAccountPolicy</c> permissions. </para></li></ul><para> If you delete a field index policy, the indexing of the log events that happened before you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs Insights queries. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLAccountPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLAccountPolicyCmdlet.PolicyType"> <summary> <para> <para>The type of policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLAccountPolicyCmdlet.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.CloudWatchLogs.Model.DeleteAccountPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLAccountPolicyCmdlet.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.CWL.RemoveCWLDataProtectionPolicyCmdlet"> <summary> Deletes the data protection policy from the specified log group. <para> For more information about data protection policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDataProtectionPolicyCmdlet.LogGroupIdentifier"> <summary> <para> <para>The name or ARN of the log group that you want to delete the data protection policy for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDataProtectionPolicyCmdlet.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.CloudWatchLogs.Model.DeleteDataProtectionPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDataProtectionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDataProtectionPolicyCmdlet.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.CWL.RemoveCWLDeliveryCmdlet"> <summary> Deletes s <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical <i>delivery destination</i>. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryCmdlet.Id"> <summary> <para> <para>The unique ID of the delivery to delete. You can find the ID of a delivery with the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryCmdlet.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.CloudWatchLogs.Model.DeleteDeliveryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryCmdlet.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.CWL.RemoveCWLDeliveryDestinationCmdlet"> <summary> Deletes a <i>delivery destination</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical <i>delivery destination</i>. <para> You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation and check the <c>deliveryDestinationArn</c> field in the results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryDestinationCmdlet.Name"> <summary> <para> <para>The name of the delivery destination that you want to delete. You can find a list of delivery destionation names by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveryDestinations.html">DescribeDeliveryDestinations</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryDestinationCmdlet.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.CloudWatchLogs.Model.DeleteDeliveryDestinationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryDestinationCmdlet.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.CWL.RemoveCWLDeliveryDestinationCmdlet.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.CWL.RemoveCWLDeliveryDestinationPolicyCmdlet"> <summary> Deletes a delivery destination policy. For more information about these policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryDestinationPolicyCmdlet.DeliveryDestinationName"> <summary> <para> <para>The name of the delivery destination that you want to delete the policy for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryDestinationPolicyCmdlet.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.CloudWatchLogs.Model.DeleteDeliveryDestinationPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryDestinationPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryDestinationName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryDestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliveryDestinationPolicyCmdlet.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.CWL.RemoveCWLDeliverySourceCmdlet"> <summary> Deletes a <i>delivery source</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical <i>delivery destination</i>. <para> You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation and check the <c>deliverySourceName</c> field in the results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliverySourceCmdlet.Name"> <summary> <para> <para>The name of the delivery source that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliverySourceCmdlet.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.CloudWatchLogs.Model.DeleteDeliverySourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDeliverySourceCmdlet.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.CWL.RemoveCWLDeliverySourceCmdlet.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.CWL.RemoveCWLDestinationCmdlet"> <summary> Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDestinationCmdlet.DestinationName"> <summary> <para> <para>The name of the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDestinationCmdlet.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.CloudWatchLogs.Model.DeleteDestinationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DestinationName parameter. The -PassThru parameter is deprecated, use -Select '^DestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDestinationCmdlet.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.CWL.RemoveCWLIndexPolicyCmdlet"> <summary> Deletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries. <para> You can't use this operation to delete an account-level index policy. Instead, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteAccountPolicy.html">DeletAccountPolicy</a>. </para><para> If you delete a log-group level field index policy and there is an account-level field index policy, in a few minutes the log group begins using that account-wide policy to index new incoming log events. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIndexPolicyCmdlet.LogGroupIdentifier"> <summary> <para> <para>The log group to delete the index policy for. You can specify either the name or the ARN of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIndexPolicyCmdlet.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.CloudWatchLogs.Model.DeleteIndexPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIndexPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIndexPolicyCmdlet.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.CWL.RemoveCWLIntegrationCmdlet"> <summary> Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify <c>true</c> for the <c>force</c> parameter, otherwise the operation will fail. If you delete the integration by setting <c>force</c> to <c>true</c>, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIntegrationCmdlet.ForceDelete"> <summary> <para> <para>Specify <c>true</c> to force the deletion of the integration even if vended logs dashboards currently exist.</para><para>The default is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIntegrationCmdlet.IntegrationName"> <summary> <para> <para>The name of the integration to delete. To find the name of your integration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html">ListIntegrations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIntegrationCmdlet.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.CloudWatchLogs.Model.DeleteIntegrationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIntegrationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IntegrationName parameter. The -PassThru parameter is deprecated, use -Select '^IntegrationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLIntegrationCmdlet.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.CWL.RemoveCWLLogAnomalyDetectorCmdlet"> <summary> Deletes the specified CloudWatch Logs anomaly detector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogAnomalyDetectorCmdlet.AnomalyDetectorArn"> <summary> <para> <para>The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors in your account by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html">ListLogAnomalyDetectors</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogAnomalyDetectorCmdlet.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.CloudWatchLogs.Model.DeleteLogAnomalyDetectorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogAnomalyDetectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnomalyDetectorArn parameter. The -PassThru parameter is deprecated, use -Select '^AnomalyDetectorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogAnomalyDetectorCmdlet.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.CWL.RemoveCWLLogGroupCmdlet"> <summary> Deletes the specified log group and permanently deletes all the archived log events associated with the log group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupCmdlet.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.CloudWatchLogs.Model.DeleteLogGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupCmdlet.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.CWL.RemoveCWLLogGroupTagCmdlet"> <summary> <important><para> The UntagLogGroup operation is on the path to deprecation. We recommend that you use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a> instead. </para></important><para> Removes the specified tags from the specified log group. </para><para> To list the tags for a log group, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>. To add tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>. </para><para> CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to log groups using the <c>aws:Resource/<i>key-name</i></c> or <c>aws:TagKeys</c> condition keys. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupTagCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupTagCmdlet.Tag"> <summary> <para> <para>The tag keys. The corresponding tags are removed from the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupTagCmdlet.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.CloudWatchLogs.Model.UntagLogGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupTagCmdlet.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.CWL.RemoveCWLLogStreamCmdlet"> <summary> Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.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.CloudWatchLogs.Model.DeleteLogStreamResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogStreamName parameter. The -PassThru parameter is deprecated, use -Select '^LogStreamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.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.CWL.RemoveCWLMetricFilterCmdlet"> <summary> Deletes the specified metric filter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.FilterName"> <summary> <para> <para>The name of the metric filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.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.CloudWatchLogs.Model.DeleteMetricFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FilterName parameter. The -PassThru parameter is deprecated, use -Select '^FilterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.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.CWL.RemoveCWLQueryDefinitionCmdlet"> <summary> Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query. <para> Each <c>DeleteQueryDefinition</c> operation can delete one query definition. </para><para> You must have the <c>logs:DeleteQueryDefinition</c> permission to be able to perform this operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLQueryDefinitionCmdlet.QueryDefinitionId"> <summary> <para> <para>The ID of the query definition that you want to delete. You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html">DescribeQueryDefinitions</a> to retrieve the IDs of your saved query definitions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLQueryDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Success'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.DeleteQueryDefinitionResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.DeleteQueryDefinitionResponse 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.CWL.RemoveCWLQueryDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryDefinitionId parameter. The -PassThru parameter is deprecated, use -Select '^QueryDefinitionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLQueryDefinitionCmdlet.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.CWL.RemoveCWLResourcePolicyCmdlet"> <summary> Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourcePolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to be revoked. This parameter is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourcePolicyCmdlet.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.CloudWatchLogs.Model.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyName parameter. The -PassThru parameter is deprecated, use -Select '^PolicyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourcePolicyCmdlet.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.CWL.RemoveCWLResourceTagCmdlet"> <summary> Removes one or more tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the CloudWatch Logs resource that you're removing tags from.</para><para>The ARN format of a log group is <c>arn:aws:logs:<i>Region</i>:<i>account-id</i>:log-group:<i>log-group-name</i></c></para><para>The ARN format of a destination is <c>arn:aws:logs:<i>Region</i>:<i>account-id</i>:destination:<i>destination-name</i></c></para><para>For more information about ARN format, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html">CloudWatch Logs resources and operations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourceTagCmdlet.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.CloudWatchLogs.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLResourceTagCmdlet.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.CWL.RemoveCWLResourceTagCmdlet.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.CWL.RemoveCWLRetentionPolicyCmdlet"> <summary> Deletes the specified retention policy. <para> Log events do not expire if they belong to log groups without a retention policy. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLRetentionPolicyCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLRetentionPolicyCmdlet.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.CloudWatchLogs.Model.DeleteRetentionPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLRetentionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLRetentionPolicyCmdlet.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.CWL.RemoveCWLSubscriptionFilterCmdlet"> <summary> Deletes the specified subscription filter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.FilterName"> <summary> <para> <para>The name of the subscription filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.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.CloudWatchLogs.Model.DeleteSubscriptionFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FilterName parameter. The -PassThru parameter is deprecated, use -Select '^FilterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.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.CWL.RemoveCWLTransformerCmdlet"> <summary> Deletes the log transformer for the specified log group. As soon as you do this, the transformation of incoming log events according to that transformer stops. If this account has an account-level transformer that applies to this log group, the log group begins using that account-level transformer when this log-group level transformer is deleted. <para> After you delete a transformer, be sure to edit any metric filters or subscription filters that relied on the transformed versions of the log events. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLTransformerCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the name or ARN of the log group to delete the transformer for. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLTransformerCmdlet.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.CloudWatchLogs.Model.DeleteTransformerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLTransformerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLTransformerCmdlet.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.CWL.StartCWLLiveTailCmdlet"> <summary> Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html">Use Live Tail to view logs in near real time</a>. <para> The response to this operation is a response stream, over which the server sends live log events and the client receives them. </para><para> The following objects are sent over the stream: </para><ul><li><para> A single <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionStart.html">LiveTailSessionStart</a> object is sent at the start of the session. </para></li><li><para> Every second, a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionUpdate.html">LiveTailSessionUpdate</a> object is sent. Each of these objects contains an array of the actual log events. </para><para> If no new log events were ingested in the past second, the <c>LiveTailSessionUpdate</c> object will contain an empty array. </para><para> The array of log events contained in a <c>LiveTailSessionUpdate</c> can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each <c>LiveTailSessionUpdate</c> object. </para><para> If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 <c>LiveTailSessionUpdate</c> events or 5000 log events, after which it starts dropping the oldest events. </para></li><li><para> A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionStreamingException">SessionStreamingException</a> object is returned if an unknown error occurs on the server side. </para></li><li><para> A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionTimeoutException">SessionTimeoutException</a> object is returned when the session times out, after it has been kept open for three hours. </para></li></ul><important><para> You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks. </para></important><para> For examples of using an SDK to start a Live Tail session, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/example_cloudwatch-logs_StartLiveTail_section.html"> Start a Live Tail session using an Amazon Web Services SDK</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLLiveTailCmdlet.LogEventFilterPattern"> <summary> <para> <para>An optional pattern to use to filter the results to include only log events that match the pattern. For example, a filter pattern of <c>error 404</c> causes only log events that include both <c>error</c> and <c>404</c> to be included in the Live Tail stream.</para><para>Regular expression filter patterns are supported.</para><para>For more information about filter pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLLiveTailCmdlet.LogGroupIdentifier"> <summary> <para> <para>An array where each item in the array is a log group to include in the Live Tail session.</para><para>Specify each log group by its ARN. </para><para>If you specify an ARN, the ARN can't end with an asterisk (*).</para><note><para> You can include up to 10 log groups.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLLiveTailCmdlet.LogStreamNamePrefix"> <summary> <para> <para>If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.</para><para>If you specify this field, you can't also specify the <c>logStreamNames</c> field.</para><note><para>You can specify this parameter only if you specify only one log group in <c>logGroupIdentifiers</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLLiveTailCmdlet.LogStreamName"> <summary> <para> <para>If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.</para><para>If you specify this field, you can't also specify the <c>logStreamNamePrefixes</c> field.</para><note><para>You can specify this parameter only if you specify only one log group in <c>logGroupIdentifiers</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLLiveTailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResponseStream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.StartLiveTailResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.StartLiveTailResponse 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.CWL.StartCWLLiveTailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogEventFilterPattern parameter. The -PassThru parameter is deprecated, use -Select '^LogEventFilterPattern' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLLiveTailCmdlet.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.CWL.StartCWLQueryCmdlet"> <summary> Starts a query of one or more log groups using CloudWatch Logs Insights. You specify the log groups and time range to query and the query string to use. <para> For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>. </para><para> After you run a query using <c>StartQuery</c>, the query results are stored by CloudWatch Logs. You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html">GetQueryResults</a> to retrieve the results of a query, using the <c>queryId</c> that <c>StartQuery</c> returns. </para><note><para> To specify the log groups to query, a <c>StartQuery</c> operation must include one of the following: </para><ul><li><para> Either exactly one of the following parameters: <c>logGroupName</c>, <c>logGroupNames</c>, or <c>logGroupIdentifiers</c></para></li><li><para> Or the <c>queryString</c> must include a <c>SOURCE</c> command to select log groups for the query. The <c>SOURCE</c> command can select log groups based on log group name prefix, account ID, and log class. </para><para> For more information about the <c>SOURCE</c> command, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax-Source.html">SOURCE</a>. </para></li></ul></note><para> If you have associated a KMS key with the query results in this account, then <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method. </para><para> Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries. </para><para> If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. For a cross-account <c>StartQuery</c> operation, the query definition must be defined in the monitoring account. </para><para> You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.EndTime"> <summary> <para> <para>The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since <c>January 1, 1970, 00:00:00 UTC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.LogGroupIdentifier"> <summary> <para> <para>The list of log groups to query. You can include up to 50 log groups.</para><para>You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.</para><para>If you specify an ARN, use the format arn:aws:logs:<i>region</i>:<i>account-id</i>:log-group:<i>log_group_name</i> Don't include an * at the end.</para><para>A <c>StartQuery</c> operation must include exactly one of the following parameters: <c>logGroupName</c>, <c>logGroupNames</c>, or <c>logGroupIdentifiers</c>. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the <c>querystring</c> instead of here. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.LogGroupName"> <summary> <para> <para>The log group on which to perform the query.</para><note><para>A <c>StartQuery</c> operation must include exactly one of the following parameters: <c>logGroupName</c>, <c>logGroupNames</c>, or <c>logGroupIdentifiers</c>. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the <c>querystring</c> instead of here.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.LogGroupNameList"> <summary> <para> <para>The list of log groups to be queried. You can include up to 50 log groups.</para><note><para>A <c>StartQuery</c> operation must include exactly one of the following parameters: <c>logGroupName</c>, <c>logGroupNames</c>, or <c>logGroupIdentifiers</c>. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the <c>querystring</c> instead of here.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.QueryLanguage"> <summary> <para> <para>Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.QueryString"> <summary> <para> <para>The query string to use. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.StartTime"> <summary> <para> <para>The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since <c>January 1, 1970, 00:00:00 UTC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.Limit"> <summary> <para> <para>The maximum number of log events to return in the query. If the query string uses the <c>fields</c> command, only the specified fields and their values are returned. The default is 10,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.StartQueryResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.StartQueryResponse 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.CWL.StartCWLQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryString parameter. The -PassThru parameter is deprecated, use -Select '^QueryString' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StartCWLQueryCmdlet.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.CWL.StopCWLExportTaskCmdlet"> <summary> Cancels the specified export task. <para> The task must be in the <c>PENDING</c> or <c>RUNNING</c> state. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLExportTaskCmdlet.TaskId"> <summary> <para> <para>The ID of the export task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLExportTaskCmdlet.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.CloudWatchLogs.Model.CancelExportTaskResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLExportTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLExportTaskCmdlet.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.CWL.StopCWLQueryCmdlet"> <summary> Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLQueryCmdlet.QueryId"> <summary> <para> <para>The ID number of the query to stop. To find this ID number, use <c>DescribeQueries</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Success'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.StopQueryResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.StopQueryResponse 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.CWL.StopCWLQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLQueryCmdlet.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.CWL.TestCWLMetricFilterCmdlet"> <summary> Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.TestCWLMetricFilterCmdlet.FilterPattern"> <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.CWL.TestCWLMetricFilterCmdlet.LogEventMessage"> <summary> <para> <para>The log event messages to test.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.TestCWLMetricFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Matches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.TestMetricFilterResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.TestMetricFilterResponse 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.CWL.TestCWLMetricFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FilterPattern parameter. The -PassThru parameter is deprecated, use -Select '^FilterPattern' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.TestCWLTransformerCmdlet"> <summary> Use this operation to test a log transformer. You enter the transformer configuration and a set of log events to test with. The operation responds with an array that includes the original log events and the transformed versions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.TestCWLTransformerCmdlet.LogEventMessage"> <summary> <para> <para>An array of the raw log events that you want to use to test this transformer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.TestCWLTransformerCmdlet.TransformerConfig"> <summary> <para> <para>This structure contains the configuration of this log transformer that you want to test. A log transformer is an array of processors, where each processor applies one type of transformation to the log events that are ingested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.TestCWLTransformerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TransformedLogs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.TestTransformerResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.TestTransformerResponse 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.CWL.UnregisterCWLKmsKeyCmdlet"> <summary> Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account. <para> When you use <c>DisassociateKmsKey</c>, you specify either the <c>logGroupName</c> parameter or the <c>resourceIdentifier</c> parameter. You can't specify both of those parameters in the same operation. </para><ul><li><para> Specify the <c>logGroupName</c> parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed. </para></li><li><para> Specify the <c>resourceIdentifier</c> parameter with the <c>query-result</c> resource to stop using the KMS key to encrypt the results of all future <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed. </para></li></ul><para> It can take up to 5 minutes for this operation to take effect. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UnregisterCWLKmsKeyCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para><para>In your <c>DisassociateKmsKey</c> operation, you must specify either the <c>resourceIdentifier</c> parameter or the <c>logGroup</c> parameter, but you can't specify both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UnregisterCWLKmsKeyCmdlet.ResourceIdentifier"> <summary> <para> <para>Specifies the target for this operation. You must specify one of the following:</para><ul><li><para>Specify the ARN of a log group to stop having CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. After you run this operation, CloudWatch Logs encrypts ingested log events with the default CloudWatch Logs method. The log group ARN must be in the following format. Replace <i>REGION</i> and <i>ACCOUNT_ID</i> with your Region and account ID.</para><para><c>arn:aws:logs:<i>REGION</i>:<i>ACCOUNT_ID</i>:log-group:<i>LOG_GROUP_NAME</i></c></para></li><li><para>Specify the following ARN to stop using this key to encrypt the results of future <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> operations in this account. Replace <i>REGION</i> and <i>ACCOUNT_ID</i> with your Region and account ID.</para><para><c>arn:aws:logs:<i>REGION</i>:<i>ACCOUNT_ID</i>:query-result:*</c></para></li></ul><para>In your <c>DisssociateKmsKey</c> operation, you must specify either the <c>resourceIdentifier</c> parameter or the <c>logGroup</c> parameter, but you can't specify both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UnregisterCWLKmsKeyCmdlet.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.CloudWatchLogs.Model.DisassociateKmsKeyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UnregisterCWLKmsKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UnregisterCWLKmsKeyCmdlet.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.CWL.UpdateCWLAnomalyCmdlet"> <summary> Use this operation to <i>suppress</i> anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern. <para> You must specify either <c>anomalyId</c> or <c>patternId</c>, but you can't specify both parameters in the same operation. </para><para> If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the <c>suppressionType</c> and <c>suppressionPeriod</c> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.AnomalyDetectorArn"> <summary> <para> <para>The ARN of the anomaly detector that this operation is to act on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.AnomalyId"> <summary> <para> <para>If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html">ListAnomalies</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.Baseline"> <summary> <para> <para>Set this to <c>true</c> to prevent CloudWatch Logs from displaying this behavior as an anomaly in the future. The behavior is then treated as baseline behavior. However, if similar but more severe occurrences of this behavior occur in the future, those will still be reported as anomalies. </para><para>The default is <c>false</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.PatternId"> <summary> <para> <para>If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html">ListAnomalies</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.SuppressionType"> <summary> <para> <para>Use this to specify whether the suppression to be temporary or infinite. If you specify <c>LIMITED</c>, you must also specify a <c>suppressionPeriod</c>. If you specify <c>INFINITE</c>, any value for <c>suppressionPeriod</c> is ignored. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.SuppressionPeriod_SuppressionUnit"> <summary> <para> <para>Specifies whether the value of <c>value</c> is in seconds, minutes, or hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.SuppressionPeriod_Value"> <summary> <para> <para>Specifies the number of seconds, minutes or hours to suppress this anomaly. There is no maximum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.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.CloudWatchLogs.Model.UpdateAnomalyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnomalyDetectorArn parameter. The -PassThru parameter is deprecated, use -Select '^AnomalyDetectorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLAnomalyCmdlet.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.CWL.UpdateCWLDeliveryConfigurationCmdlet"> <summary> Use this operation to update the configuration of a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Delivery.html">delivery</a> to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.S3DeliveryConfiguration_EnableHiveCompatiblePath"> <summary> <para> <para>This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.FieldDelimiter"> <summary> <para> <para>The field delimiter to use between record fields when the final output format of a delivery is in <c>Plain</c>, <c>W3C</c>, or <c>Raw</c> format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.Id"> <summary> <para> <para>The ID of the delivery to be updated by this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.RecordField"> <summary> <para> <para>The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.S3DeliveryConfiguration_SuffixPath"> <summary> <para> <para>This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.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.CloudWatchLogs.Model.UpdateDeliveryConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLDeliveryConfigurationCmdlet.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.CWL.UpdateCWLLogAnomalyDetectorCmdlet"> <summary> Updates an existing log anomaly detector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLLogAnomalyDetectorCmdlet.AnomalyDetectorArn"> <summary> <para> <para>The ARN of the anomaly detector that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLLogAnomalyDetectorCmdlet.AnomalyVisibilityTime"> <summary> <para> <para>The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an anomaly during this time, it will be considered normal going forward and will not be detected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLLogAnomalyDetectorCmdlet.Enabled"> <summary> <para> <para>Use this parameter to pause or restart the anomaly detector. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLLogAnomalyDetectorCmdlet.EvaluationFrequency"> <summary> <para> <para>Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting <c>evaluationFrequency</c> to <c>FIFTEEN_MIN</c> might be appropriate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLLogAnomalyDetectorCmdlet.FilterPattern"> <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.CWL.UpdateCWLLogAnomalyDetectorCmdlet.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.CloudWatchLogs.Model.UpdateLogAnomalyDetectorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.UpdateCWLLogAnomalyDetectorCmdlet.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.CWL.WriteCWLAccountPolicyCmdlet"> <summary> Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account. <para><b>Data protection policy</b></para><para> A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy. </para><important><para> Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked. </para></important><para> If you use <c>PutAccountPolicy</c> to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked. </para><para> By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the <c>logs:Unmask</c> permission can use a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a> operation with the <c>unmask</c> parameter set to <c>true</c> to view the unmasked log events. Users with the <c>logs:Unmask</c> can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the <c>unmask</c> query command. </para><para> For more information, including a list of types of data that can be audited and masked, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data with masking</a>. </para><para> To use the <c>PutAccountPolicy</c> operation for a data protection policy, you must be signed on with the <c>logs:PutDataProtectionPolicy</c> and <c>logs:PutAccountPolicy</c> permissions. </para><para> The <c>PutAccountPolicy</c> operation applies to all log groups in the account. You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a> to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked. </para><para><b>Subscription filter policy</b></para><para> A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format. </para><para> The following destinations are supported for subscription filters: </para><ul><li><para> An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery. </para></li><li><para> An Firehose data stream in the same account as the subscription policy, for same-account delivery. </para></li><li><para> A Lambda function in the same account as the subscription policy, for same-account delivery. </para></li><li><para> A logical destination in a different account created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html">PutDestination</a>, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations. </para></li></ul><para> Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in <c>PolicyName</c>. To perform a <c>PutAccountPolicy</c> subscription filter operation for any destination except a Lambda function, you must also have the <c>iam:PassRole</c> permission. </para><para><b>Transformer policy</b></para><para> Creates or updates a <i>log transformer policy</i> for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters. </para><para> You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region. </para><para> A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors"> Processors that you can use</a>. </para><para> Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies. </para><para> You can create transformers only for the log groups in the Standard log class. </para><para> You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the <c>selectionCriteria</c> parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with <c>my-log</c>, you can't have another field index policy filtered to <c>my-logpprod</c> or <c>my-logging</c>. </para><para> You can also set up a transformer at the log-group level. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html">PutTransformer</a>. If there is both a log-group level transformer created with <c>PutTransformer</c> and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer. </para><para><b>Field index policy</b></para><para> You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html">Create field indexes to improve query performance and reduce costs</a></para><para> To find the fields that are in your log group events, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html">GetLogGroupFields</a> operation. </para><para> For example, suppose you have created a field index for <c>requestId</c>. Then, any CloudWatch Logs Insights query on that log group that includes <c>requestId = <i>value</i></c> or <c>requestId in [<i>value</i>, <i>value</i>, ...]</c> will attempt to process only the log events where the indexed field matches the specified value. </para><para> Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of <c>RequestId</c> won't match a log event containing <c>requestId</c>. </para><para> You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the <c>selectionCriteria</c> parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with <c>my-log</c>, you can't have another field index policy filtered to <c>my-logpprod</c> or <c>my-logging</c>. </para><para> If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts. </para><para> If you want to create a field index policy for a single log group, you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a> instead of <c>PutAccountPolicy</c>. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLAccountPolicyCmdlet.PolicyDocument"> <summary> <para> <para>Specify the policy, in JSON.</para><para><b>Data protection policy</b></para><para>A data protection policy must include two JSON blocks:</para><ul><li><para>The first block must include both a <c>DataIdentifer</c> array and an <c>Operation</c> property with an <c>Audit</c> action. The <c>DataIdentifer</c> array lists the types of sensitive data that you want to mask. For more information about the available options, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html">Types of data that you can mask</a>.</para><para>The <c>Operation</c> property with an <c>Audit</c> action is required to find the sensitive data terms. This <c>Audit</c> action must contain a <c>FindingsDestination</c> object. You can optionally use that <c>FindingsDestination</c> object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist.</para></li><li><para>The second block must include both a <c>DataIdentifer</c> array and an <c>Operation</c> property with an <c>Deidentify</c> action. The <c>DataIdentifer</c> array must exactly match the <c>DataIdentifer</c> array in the first block of the policy.</para><para>The <c>Operation</c> property with the <c>Deidentify</c> action is what actually masks the data, and it must contain the <c> "MaskConfig": {}</c> object. The <c> "MaskConfig": {}</c> object must be empty.</para></li></ul><para>For an example data protection policy, see the <b>Examples</b> section on this page.</para><important><para>The contents of the two <c>DataIdentifer</c> arrays must match exactly.</para></important><para>In addition to the two JSON blocks, the <c>policyDocument</c> can also include <c>Name</c>, <c>Description</c>, and <c>Version</c> fields. The <c>Name</c> is different than the operation's <c>policyName</c> parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.</para><para>The JSON specified in <c>policyDocument</c> can be up to 30,720 characters long.</para><para><b>Subscription filter policy</b></para><para>A subscription filter policy can include the following attributes in a JSON block:</para><ul><li><para><b>DestinationArn</b> The ARN of the destination to deliver log events to. Supported destinations are:</para><ul><li><para>An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.</para></li><li><para>An Firehose data stream in the same account as the subscription policy, for same-account delivery.</para></li><li><para>A Lambda function in the same account as the subscription policy, for same-account delivery.</para></li><li><para>A logical destination in a different account created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html">PutDestination</a>, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.</para></li></ul></li><li><para><b>RoleArn</b> The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.</para></li><li><para><b>FilterPattern</b> A filter pattern for subscribing to a filtered stream of log events.</para></li><li><para><b>Distribution</b> The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to <c>Random</c> for a more even distribution. This property is only applicable when the destination is an Kinesis Data Streams data stream.</para></li></ul><para><b>Transformer policy</b></para><para>A transformer policy must include one JSON block with the array of processors and their configurations. For more information about available processors, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors"> Processors that you can use</a>. </para><para><b>Field index policy</b></para><para>A field index filter policy can include the following attribute in a JSON block:</para><ul><li><para><b>Fields</b> The array of field indexes to create.</para></li></ul><para>It must contain at least one field index.</para><para>The following is an example of an index policy document that creates two indexes, <c>RequestId</c> and <c>TransactionId</c>.</para><para><c>"policyDocument": "{ \"Fields\": [ \"RequestId\", \"TransactionId\" ] }"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLAccountPolicyCmdlet.PolicyName"> <summary> <para> <para>A name for the policy. This must be unique within the account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLAccountPolicyCmdlet.PolicyType"> <summary> <para> <para>The type of policy that you're creating or updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLAccountPolicyCmdlet.Scope"> <summary> <para> <para>Currently the only valid value for this parameter is <c>ALL</c>, which specifies that the data protection policy applies to all log groups in the account. If you omit this parameter, the default of <c>ALL</c> is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLAccountPolicyCmdlet.SelectionCriterion"> <summary> <para> <para>Use this parameter to apply the new policy to a subset of log groups in the account.</para><para>Specifing <c>selectionCriteria</c> is valid only when you specify <c>SUBSCRIPTION_FILTER_POLICY</c>, <c>FIELD_INDEX_POLICY</c> or <c>TRANSFORMER_POLICY</c>for <c>policyType</c>.</para><para>If <c>policyType</c> is <c>SUBSCRIPTION_FILTER_POLICY</c>, the only supported <c>selectionCriteria</c> filter is <c>LogGroupName NOT IN []</c></para><para>If <c>policyType</c> is <c>FIELD_INDEX_POLICY</c> or <c>TRANSFORMER_POLICY</c>, the only supported <c>selectionCriteria</c> filter is <c>LogGroupNamePrefix</c></para><para>The <c>selectionCriteria</c> string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.</para><para>Using the <c>selectionCriteria</c> parameter with <c>SUBSCRIPTION_FILTER_POLICY</c> is useful to help prevent infinite loops. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions-recursion-prevention.html">Log recursion prevention</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLAccountPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutAccountPolicyResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutAccountPolicyResponse 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.CWL.WriteCWLAccountPolicyCmdlet.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.CWL.WriteCWLDataProtectionPolicyCmdlet"> <summary> Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. <important><para> Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked. </para></important><para> By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the <c>logs:Unmask</c> permission can use a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a> operation with the <c>unmask</c> parameter set to <c>true</c> to view the unmasked log events. Users with the <c>logs:Unmask</c> can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the <c>unmask</c> query command. </para><para> For more information, including a list of types of data that can be audited and masked, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data with masking</a>. </para><para> The <c>PutDataProtectionPolicy</c> operation applies to only the specified log group. You can also use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a> to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDataProtectionPolicyCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the log group name or log group ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDataProtectionPolicyCmdlet.PolicyDocument"> <summary> <para> <para>Specify the data protection policy, in JSON.</para><para>This policy must include two JSON blocks:</para><ul><li><para>The first block must include both a <c>DataIdentifer</c> array and an <c>Operation</c> property with an <c>Audit</c> action. The <c>DataIdentifer</c> array lists the types of sensitive data that you want to mask. For more information about the available options, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html">Types of data that you can mask</a>.</para><para>The <c>Operation</c> property with an <c>Audit</c> action is required to find the sensitive data terms. This <c>Audit</c> action must contain a <c>FindingsDestination</c> object. You can optionally use that <c>FindingsDestination</c> object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist.</para></li><li><para>The second block must include both a <c>DataIdentifer</c> array and an <c>Operation</c> property with an <c>Deidentify</c> action. The <c>DataIdentifer</c> array must exactly match the <c>DataIdentifer</c> array in the first block of the policy.</para><para>The <c>Operation</c> property with the <c>Deidentify</c> action is what actually masks the data, and it must contain the <c> "MaskConfig": {}</c> object. The <c> "MaskConfig": {}</c> object must be empty.</para></li></ul><para>For an example data protection policy, see the <b>Examples</b> section on this page.</para><important><para>The contents of the two <c>DataIdentifer</c> arrays must match exactly.</para></important><para>In addition to the two JSON blocks, the <c>policyDocument</c> can also include <c>Name</c>, <c>Description</c>, and <c>Version</c> fields. The <c>Name</c> is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.</para><para>The JSON specified in <c>policyDocument</c> can be up to 30,720 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDataProtectionPolicyCmdlet.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.CloudWatchLogs.Model.PutDataProtectionPolicyResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutDataProtectionPolicyResponse 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.CWL.WriteCWLDataProtectionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDataProtectionPolicyCmdlet.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.CWL.WriteCWLDeliveryDestinationCmdlet"> <summary> Creates or updates a logical <i>delivery destination</i>. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations. <para> To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following: </para><ul><li><para> Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>. </para></li><li><para> Use <c>PutDeliveryDestination</c> to create a <i>delivery destination</i>, which is a logical object that represents the actual delivery destination. </para></li><li><para> If you are delivering logs cross-account, you must use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a> in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. </para></li><li><para> Use <c>CreateDelivery</c> to create a <i>delivery</i> by pairing exactly one delivery source and one delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>. </para></li></ul><para> You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination. </para><para> Only some Amazon Web Services services support being configured as a delivery source. These services are listed as <b>Supported [V2 Permissions]</b> in the table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from Amazon Web Services services.</a></para><para> If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationCmdlet.DeliveryDestinationConfiguration_DestinationResourceArn"> <summary> <para> <para>The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationCmdlet.Name"> <summary> <para> <para>A name for this delivery destination. This name must be unique for all delivery destinations in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationCmdlet.OutputFormat"> <summary> <para> <para>The format for the logs that this delivery destination will receive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationCmdlet.Tag"> <summary> <para> <para>An optional list of key-value pairs to associate with the resource.</para><para>For more information about tagging, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliveryDestination'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutDeliveryDestinationResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutDeliveryDestinationResponse 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.CWL.WriteCWLDeliveryDestinationCmdlet.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.CWL.WriteCWLDeliveryDestinationCmdlet.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.CWL.WriteCWLDeliveryDestinationPolicyCmdlet"> <summary> Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following: <ul><li><para> Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>. </para></li><li><para> Create a <i>delivery destination</i>, which is a logical object that represents the actual delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">PutDeliveryDestination</a>. </para></li><li><para> Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. </para></li><li><para> Create a <i>delivery</i> by pairing exactly one delivery source and one delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>. </para></li></ul><para> Only some Amazon Web Services services support being configured as a delivery source. These services are listed as <b>Supported [V2 Permissions]</b> in the table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from Amazon Web Services services.</a></para><para> The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationPolicyCmdlet.DeliveryDestinationName"> <summary> <para> <para>The name of the delivery destination to assign this policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationPolicyCmdlet.DeliveryDestinationPolicy"> <summary> <para> <para>The contents of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutDeliveryDestinationPolicyResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutDeliveryDestinationPolicyResponse 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.CWL.WriteCWLDeliveryDestinationPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryDestinationName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryDestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliveryDestinationPolicyCmdlet.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.CWL.WriteCWLDeliverySourceCmdlet"> <summary> Creates or updates a logical <i>delivery source</i>. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. <para> To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following: </para><ul><li><para> Use <c>PutDeliverySource</c> to create a delivery source, which is a logical object that represents the resource that is actually sending the logs. </para></li><li><para> Use <c>PutDeliveryDestination</c> to create a <i>delivery destination</i>, which is a logical object that represents the actual delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">PutDeliveryDestination</a>. </para></li><li><para> If you are delivering logs cross-account, you must use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a> in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. </para></li><li><para> Use <c>CreateDelivery</c> to create a <i>delivery</i> by pairing exactly one delivery source and one delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>. </para></li></ul><para> You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination. </para><para> Only some Amazon Web Services services support being configured as a delivery source. These services are listed as <b>Supported [V2 Permissions]</b> in the table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from Amazon Web Services services.</a></para><para> If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliverySourceCmdlet.LogType"> <summary> <para> <para>Defines the type of log that the source is sending.</para><ul><li><para>For Amazon Bedrock, the valid value is <c>APPLICATION_LOGS</c>.</para></li><li><para>For Amazon CodeWhisperer, the valid value is <c>EVENT_LOGS</c>.</para></li><li><para>For IAM Identity Center, the valid value is <c>ERROR_LOGS</c>.</para></li><li><para>For Amazon WorkMail, the valid values are <c>ACCESS_CONTROL_LOGS</c>, <c>AUTHENTICATION_LOGS</c>, <c>WORKMAIL_AVAILABILITY_PROVIDER_LOGS</c>, and <c>WORKMAIL_MAILBOX_ACCESS_LOGS</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliverySourceCmdlet.Name"> <summary> <para> <para>A name for this delivery source. This name must be unique for all delivery sources in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliverySourceCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the Amazon Web Services resource that is generating and sending logs. For example, <c>arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliverySourceCmdlet.Tag"> <summary> <para> <para>An optional list of key-value pairs to associate with the resource.</para><para>For more information about tagging, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDeliverySourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliverySource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutDeliverySourceResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutDeliverySourceResponse 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.CWL.WriteCWLDeliverySourceCmdlet.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.CWL.WriteCWLDeliverySourceCmdlet.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.CWL.WriteCWLDestinationCmdlet"> <summary> Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions. <para> A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>. </para><para> Through an access policy, a destination controls what is written to it. By default, <c>PutDestination</c> does not set any access policy with the destination, which means a cross-account user cannot call <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html">PutSubscriptionFilter</a> against this destination. To enable this, the destination owner must call <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html">PutDestinationPolicy</a> after <c>PutDestination</c>. </para><para> To perform a <c>PutDestination</c> operation, you must also have the <c>iam:PassRole</c> permission. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.DestinationName"> <summary> <para> <para>A name for the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.RoleArn"> <summary> <para> <para>The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis <c>PutRecord</c> operation on the destination stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.Tag"> <summary> <para> <para>An optional list of key-value pairs to associate with the resource.</para><para>For more information about tagging, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.TargetArn"> <summary> <para> <para>The ARN of an Amazon Kinesis stream to which to deliver matching log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Destination'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutDestinationResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutDestinationResponse 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.CWL.WriteCWLDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DestinationName parameter. The -PassThru parameter is deprecated, use -Select '^DestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.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.CWL.WriteCWLDestinationPolicyCmdlet"> <summary> Creates or updates an access policy associated with an existing destination. An access policy is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.AccessPolicy"> <summary> <para> <para>An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.DestinationName"> <summary> <para> <para>A name for an existing destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.ForceUpdate"> <summary> <para> <para>Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying <c>true</c> for <c>forceUpdate</c>, you are affirming that you have already updated the subscription filters. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html"> Updating an existing cross-account subscription</a></para><para>If you omit this parameter, the default of <c>false</c> is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.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.CloudWatchLogs.Model.PutDestinationPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DestinationName parameter. The -PassThru parameter is deprecated, use -Select '^DestinationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.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.CWL.WriteCWLIndexPolicyCmdlet"> <summary> Creates or updates a <i>field index policy</i> for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a>. <para> You can use field index policies to create <i>field indexes</i> on fields found in log events in the log group. Creating field indexes speeds up and lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html">Create field indexes to improve query performance and reduce costs</a>. </para><para> To find the fields that are in your log group events, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html">GetLogGroupFields</a> operation. </para><para> For example, suppose you have created a field index for <c>requestId</c>. Then, any CloudWatch Logs Insights query on that log group that includes <c>requestId = <i>value</i></c> or <c>requestId IN [<i>value</i>, <i>value</i>, ...]</c> will process fewer log events to reduce costs, and have improved performance. </para><para> Each index policy has the following quotas and restrictions: </para><ul><li><para> As many as 20 fields can be included in the policy. </para></li><li><para> Each field name can include as many as 100 characters. </para></li></ul><para> Matches of log events to the names of indexed fields are case-sensitive. For example, a field index of <c>RequestId</c> won't match a log event containing <c>requestId</c>. </para><para> Log group-level field index policies created with <c>PutIndexPolicy</c> override account-level field index policies created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>. If you use <c>PutIndexPolicy</c> to create a field index policy for a log group, that log group uses only that policy. The log group ignores any account-wide field index policy that you might have created. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIndexPolicyCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the log group name or log group ARN to apply this field index policy to. If you specify an ARN, use the format arn:aws:logs:<i>region</i>:<i>account-id</i>:log-group:<i>log_group_name</i> Don't include an * at the end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIndexPolicyCmdlet.PolicyDocument"> <summary> <para> <para>The index policy document, in JSON format. The following is an example of an index policy document that creates two indexes, <c>RequestId</c> and <c>TransactionId</c>.</para><para><c>"policyDocument": "{ "Fields": [ "RequestId", "TransactionId" ] }"</c></para><para>The policy document must include at least one field index. For more information about the fields that can be included and other restrictions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Syntax.html">Field index syntax and quotas</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIndexPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndexPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutIndexPolicyResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutIndexPolicyResponse 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.CWL.WriteCWLIndexPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIndexPolicyCmdlet.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.CWL.WriteCWLIntegrationCmdlet"> <summary> Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account. <para> Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-OpenSearch-Dashboards.html">Vended log dashboards powered by Amazon OpenSearch Service</a>. </para><para> You can use this operation only to create a new integration. You can't modify an existing integration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.OpenSearchResourceConfig_ApplicationArn"> <summary> <para> <para>If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.OpenSearchResourceConfig_DashboardViewerPrincipal"> <summary> <para> <para>Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.</para><important><para>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardsAccess</b> IAM policy. For more information, see </para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.OpenSearchResourceConfig_DataSourceRoleArn"> <summary> <para> <para>Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see <a href="https://docs.aws.amazon.com/OpenSearch-Dashboards-CreateRole">Create an IAM role to access the OpenSearch Service collection</a> in the CloudWatch Logs User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.IntegrationName"> <summary> <para> <para>A name for the integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.IntegrationType"> <summary> <para> <para>The type of integration. Currently, the only supported type is <c>OPENSEARCH</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.OpenSearchResourceConfig_KmsKeyArn"> <summary> <para> <para>To have the vended dashboard data encrypted with KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the KMS key that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.OpenSearchResourceConfig_RetentionDay"> <summary> <para> <para>Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLIntegrationCmdlet.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.CloudWatchLogs.Model.PutIntegrationResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutIntegrationResponse 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.CWL.WriteCWLIntegrationCmdlet.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.CWL.WriteCWLLogEventCmdlet"> <summary> Uploads a batch of log events to the specified log stream. <important><para> The sequence token is now ignored in <c>PutLogEvents</c> actions. <c>PutLogEvents</c> actions are always accepted and never return <c>InvalidSequenceTokenException</c> or <c>DataAlreadyAcceptedException</c> even if the sequence token is not valid. You can use parallel <c>PutLogEvents</c> actions on the same log stream. </para></important><para> The batch of events must satisfy the following constraints: </para><ul><li><para> The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. </para></li><li><para> None of the log events in the batch can be more than 2 hours in the future. </para></li><li><para> None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group. </para></li><li><para> The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after <c>Jan 1, 1970 00:00:00 UTC</c>. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: <c>yyyy-mm-ddThh:mm:ss</c>. For example, <c>2017-09-15T13:45:30</c>.) </para></li><li><para> A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails. </para></li><li><para> Each log event can be no larger than 256 KB. </para></li><li><para> The maximum number of log events in a batch is 10,000. </para></li><li><important><para> The quota of five requests per second per log stream has been removed. Instead, <c>PutLogEvents</c> actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service. </para></important></li></ul><para> If a call to <c>PutLogEvents</c> returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.Entity_Attribute"> <summary> <para> <para>Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.</para><para>For details about how to use the attributes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How to add related information to telemetry</a> in the <i>CloudWatch User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.Entity_KeyAttribute"> <summary> <para> <para>The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same <c>keyAttributes</c> are considered to be the same entity.</para><para>There are five allowed attributes (key names): <c>Type</c>, <c>ResourceType</c>, <c>Identifier</c><c>Name</c>, and <c>Environment</c>.</para><para>For details about how to use the key attributes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How to add related information to telemetry</a> in the <i>CloudWatch User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.LogEvent"> <summary> <para> <para>The log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.SequenceToken"> <summary> <para> <para>The sequence token obtained from the response of the previous <c>PutLogEvents</c> call.</para><important><para>The <c>sequenceToken</c> parameter is now ignored in <c>PutLogEvents</c> actions. <c>PutLogEvents</c> actions are now accepted and never return <c>InvalidSequenceTokenException</c> or <c>DataAlreadyAcceptedException</c> even if the sequence token is not valid.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NextSequenceToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutLogEventsResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutLogEventsResponse 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.CWL.WriteCWLLogEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SequenceToken parameter. The -PassThru parameter is deprecated, use -Select '^SequenceToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventCmdlet.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.CWL.WriteCWLMetricFilterCmdlet"> <summary> Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>. <para> The maximum number of metric filters that can be associated with a log group is 100. </para><para> Using regular expressions to create metric filters is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in metric filters, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html"> Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>. </para><para> When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created. </para><important><para> Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as <c>IPAddress</c> or <c>requestID</c> as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. </para><para> CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour. </para><para> You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html"> Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.ApplyOnTransformedLog"> <summary> <para> <para>This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html">PutTransformer</a>.</para><para>If the log group uses either a log-group level or account-level transformer, and you specify <c>true</c>, the metric filter will be applied on the transformed version of the log events instead of the original ingested log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.FilterName"> <summary> <para> <para>A name for the metric filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.FilterPattern"> <summary> <para> <para>A filter pattern for extracting metric data out of ingested log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.MetricTransformation"> <summary> <para> <para>A collection of information that defines how metric data gets emitted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.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.CloudWatchLogs.Model.PutMetricFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.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.CWL.WriteCWLQueryDefinitionCmdlet"> <summary> Creates or updates a query definition for CloudWatch Logs Insights. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">Analyzing Log Data with CloudWatch Logs Insights</a>. <para> To update a query definition, specify its <c>queryDefinitionId</c> in your request. The values of <c>name</c>, <c>queryString</c>, and <c>logGroupNames</c> are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the <c>logGroupNames</c> parameter in your update operation, the query definition changes to contain no log groups. </para><para> You must have the <c>logs:PutQueryDefinition</c> permission to be able to perform this operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLQueryDefinitionCmdlet.LogGroupName"> <summary> <para> <para>Use this parameter to include specific log groups as part of your query definition. If your query uses the OpenSearch Service query language, you specify the log group names inside the <c>querystring</c> instead of here.</para><para>If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLQueryDefinitionCmdlet.Name"> <summary> <para> <para>A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the <c>queryDefinitionNamePrefix</c> parameter of <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html">DescribeQueryDefinitions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLQueryDefinitionCmdlet.QueryDefinitionId"> <summary> <para> <para>If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html">DescribeQueryDefinitions</a> to retrieve the IDs of your saved query definitions.</para><para>If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLQueryDefinitionCmdlet.QueryLanguage"> <summary> <para> <para>Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLQueryDefinitionCmdlet.QueryString"> <summary> <para> <para>The query string to use for this definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLQueryDefinitionCmdlet.ClientToken"> <summary> <para> <para>Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLQueryDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryDefinitionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutQueryDefinitionResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutQueryDefinitionResponse 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.CWL.WriteCWLQueryDefinitionCmdlet.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.CWL.WriteCWLQueryDefinitionCmdlet.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.CWL.WriteCWLResourcePolicyCmdlet"> <summary> Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLResourcePolicyCmdlet.PolicyDocument"> <summary> <para> <para>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.</para><para>The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace <c>"logArn"</c> with the ARN of your CloudWatch Logs resource, such as a log group or log stream.</para><para>CloudWatch Logs also supports <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn">aws:SourceArn</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount">aws:SourceAccount</a> condition context keys.</para><para>In the example resource policy, you would replace the value of <c>SourceArn</c> with the resource making the call from Route 53 to CloudWatch Logs. You would also replace the value of <c>SourceAccount</c> with the Amazon Web Services account ID making that call.</para><para><c>{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLResourcePolicyCmdlet.PolicyName"> <summary> <para> <para>Name of the new policy. This parameter is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutResourcePolicyResponse 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.CWL.WriteCWLResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyName parameter. The -PassThru parameter is deprecated, use -Select '^PolicyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLResourcePolicyCmdlet.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.CWL.WriteCWLRetentionPolicyCmdlet"> <summary> Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group. <note><para> CloudWatch Logs doesn't immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer. </para><para> To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven't been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted. </para><para> When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the <c>storedBytes</c> value to see how many bytes a log group is storing. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.RetentionInDays"> <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.CWL.WriteCWLRetentionPolicyCmdlet.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.CloudWatchLogs.Model.PutRetentionPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.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.CWL.WriteCWLSubscriptionFilterCmdlet"> <summary> Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a> and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format. <para> The following destinations are supported for subscription filters: </para><ul><li><para> An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery. </para></li><li><para> A logical destination created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html">PutDestination</a> that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations. </para></li><li><para> An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. </para></li><li><para> An Lambda function that belongs to the same account as the subscription filter, for same-account delivery. </para></li></ul><para> Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in <c>filterName</c>. </para><para> Using regular expressions to create subscription filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in subscription filters, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html"> Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>. </para><para> To perform a <c>PutSubscriptionFilter</c> operation for any destination except a Lambda function, you must also have the <c>iam:PassRole</c> permission. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.ApplyOnTransformedLog"> <summary> <para> <para>This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html">PutTransformer</a>.</para><para>If the log group uses either a log-group level or account-level transformer, and you specify <c>true</c>, the subscription filter will be applied on the transformed version of the log events instead of the original ingested log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.DestinationArn"> <summary> <para> <para>The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:</para><ul><li><para>An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.</para></li><li><para>A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.</para><para>If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html">PutDestinationPolicy</a>.</para></li><li><para>A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.</para></li><li><para>A Lambda function belonging to the same account as the subscription filter, for same-account delivery.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.Distribution"> <summary> <para> <para>The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.FilterName"> <summary> <para> <para>A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in <c>filterName</c>. To find the name of the filter currently associated with a log group, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html">DescribeSubscriptionFilters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.FilterPattern"> <summary> <para> <para>A filter pattern for subscribing to a filtered stream of log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.RoleArn"> <summary> <para> <para>The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.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.CloudWatchLogs.Model.PutSubscriptionFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.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.CWL.WriteCWLTransformerCmdlet"> <summary> Creates or updates a <i>log transformer</i> for a single log group. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contains relevant, source-specific information. <para> After you have created a transformer, CloudWatch Logs performs the transformations at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filers. </para><para> You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region. </para><para> A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. The processors work one after another, in the order that you list them, like a pipeline. For more information about the available processors to use in a transformer, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors"> Processors that you can use</a>. </para><para> Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies. </para><para> You can create transformers only for the log groups in the Standard log class. </para><para> You can also set up a transformer at the account level. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>. If there is both a log-group level transformer created with <c>PutTransformer</c> and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLTransformerCmdlet.LogGroupIdentifier"> <summary> <para> <para>Specify either the name or ARN of the log group to create the transformer for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLTransformerCmdlet.TransformerConfig"> <summary> <para> <para>This structure contains the configuration of this log transformer. A log transformer is an array of processors, where each processor applies one type of transformation to the log events that are ingested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLTransformerCmdlet.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.CloudWatchLogs.Model.PutTransformerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLTransformerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LogGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LogGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLTransformerCmdlet.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> |