AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS X-Ray UpdateSamplingRule API operation.

Syntax

Update-XRSamplingRule
-SamplingRuleUpdate_Attribute <Hashtable>
-SamplingRateBoost_CooldownWindowMinute <Int32>
-SamplingRuleUpdate_FixedRate <Double>
-SamplingRuleUpdate_Host <String>
-SamplingRuleUpdate_HTTPMethod <String>
-SamplingRateBoost_MaxRate <Double>
-SamplingRuleUpdate_Priority <Int32>
-SamplingRuleUpdate_ReservoirSize <Int32>
-SamplingRuleUpdate_ResourceARN <String>
-SamplingRuleUpdate_RuleARN <String>
-SamplingRuleUpdate_RuleName <String>
-SamplingRuleUpdate_ServiceName <String>
-SamplingRuleUpdate_ServiceType <String>
-SamplingRuleUpdate_URLPath <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonXRayConfig>

Description

Modifies a sampling rule's configuration.

Parameters

-ClientConfig <AmazonXRayConfig>
Amazon.PowerShell.Cmdlets.XR.AmazonXRayClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRateBoost_CooldownWindowMinute <Int32>
Sets the time window (in minutes) in which only one sampling rate boost can be triggered. After a boost occurs, no further boosts are allowed until the next window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamplingRuleUpdate_SamplingRateBoost_CooldownWindowMinutes
-SamplingRateBoost_MaxRate <Double>
Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamplingRuleUpdate_SamplingRateBoost_MaxRate
-SamplingRuleUpdate_Attribute <Hashtable>
Matches attributes derived from the request. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamplingRuleUpdate_Attributes
-SamplingRuleUpdate_FixedRate <Double>
The percentage of matching requests to instrument, after the reservoir is exhausted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_Host <String>
Matches the hostname from a request URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_HTTPMethod <String>
Matches the HTTP method of a request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_Priority <Int32>
The priority of the sampling rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_ReservoirSize <Int32>
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_ResourceARN <String>
Matches the ARN of the Amazon Web Services resource on which the service runs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_RuleARN <String>
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_RuleName <String>
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_ServiceName <String>
Matches the name that the service uses to identify itself in segments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_ServiceType <String>
Matches the origin that the service uses to identify its type in segments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamplingRuleUpdate_URLPath <String>
Matches the path from a request URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'SamplingRuleRecord'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.UpdateSamplingRuleResponse). Specifying the name of a property of type Amazon.XRay.Model.UpdateSamplingRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.XRay.Model.SamplingRuleRecord or Amazon.XRay.Model.UpdateSamplingRuleResponse
This cmdlet returns an Amazon.XRay.Model.SamplingRuleRecord object. The service call response (type Amazon.XRay.Model.UpdateSamplingRuleResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z