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 Amazon CloudWatch Application Signals GetInstrumentationConfigurationStatus API operation.

Syntax

Get-CWASInstrumentationConfigurationStatus
-LocationIdentifier_CodeLocation_ClassName <String>
-LocationIdentifier_CodeLocation_CodeUnit <String>
-EndTime <DateTime>
-Environment <String>
-LocationIdentifier_CodeLocation_FilePath <String>
-InstrumentationType <InstrumentationType>
-LocationIdentifier_CodeLocation_Language <ProgrammingLanguage>
-LocationIdentifier_CodeLocation_LineNumber <Int32>
-LocationIdentifier_LocationHash <String>
-LocationIdentifier_CodeLocation_MethodName <String>
-Service <String>
-SignalType <DynamicInstrumentationSignalType>
-StartTime <DateTime>
-Status <InstrumentationConfigurationStatus>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonApplicationSignalsConfig>

Description

Retrieves the status history for a single instrumentation configuration during a specified time range. The response lists when the configuration was ACTIVE, READY, ERROR, or DISABLED. If no status or time window is provided, the operation defaults to ACTIVE events from the last hour.

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.

Parameters

-ClientConfig <AmazonApplicationSignalsConfig>
Amazon.PowerShell.Cmdlets.CWAS.AmazonApplicationSignalsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndTime <DateTime>
The end of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment <String>
Environment name for the instrumentation configuration.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstrumentationType <InstrumentationType>
Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationIdentifier_CodeLocation_ClassName <String>
The class or type name that contains the method. This is required for Java and optional for Python module-level functions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationIdentifier_CodeLocation_CodeUnit <String>
The package, module, or namespace that contains the target code, for example com.amazon.payment or payment_service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationIdentifier_CodeLocation_FilePath <String>
The source file path relative to the project or source root, such as src/payment/PaymentProcessor.java or src/payment/PaymentProcessor.py.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationIdentifier_CodeLocation_Language <ProgrammingLanguage>
The programming language for this instrumentation point, such as Java, Python, or JavaScript.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationIdentifier_CodeLocation_LineNumber <Int32>
The line number to instrument. Provide this to disambiguate overloaded methods and to target a specific line when needed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationIdentifier_CodeLocation_MethodName <String>
The method or function name to instrument, such as validateCreditCard or __init__.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationIdentifier_LocationHash <String>
The pre-computed location hash (16-character hex string)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
The maximum number of status events to return in one call. The default is 60.
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems, MaxResults
-NextToken <String>
Use the token returned by a previous call to retrieve the next page of status events.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.ApplicationSignals.Model.GetInstrumentationConfigurationStatusResponse). Specifying the name of a property of type Amazon.ApplicationSignals.Model.GetInstrumentationConfigurationStatusResponse 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)
-Service <String>
Service name for the instrumentation configuration.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SignalType <DynamicInstrumentationSignalType>
Signal type for the instrumentation configuration.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTime <DateTime>
The start of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Status <InstrumentationConfigurationStatus>
The single status to query for. If omitted, only ACTIVE status events are returned.
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.ApplicationSignals.Model.GetInstrumentationConfigurationStatusResponse
This cmdlet returns an Amazon.ApplicationSignals.Model.GetInstrumentationConfigurationStatusResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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