Documentation home for Transend tools
Get-AWSInstanceStatus
SYNOPSIS
Retrieves the status of instances in an AWS region.
SYNTAX
Get-AWSInstanceStatus [[-Project] <String>] [[-ProfileName] <String>] [[-Region] <String>]
[[-Service] <Object>] [<CommonParameters>]
DESCRIPTION
Use the Get-AWSInstanceStatus cmdlet to retrieve instances in an AWS region
and print their current statuses to the screen.
EXAMPLES
Example 1
Get-AWSInstanceStatus -Region 'us-west-2'
Gets the current status of all instances in the Oregon region.
Example 2
Get-AWSInstanceStatus -Region 'us-west-2' -Project 'Initech'
Gets the current status of all instances in the Oregon region that have a Project tag set to Initech.
PARAMETERS
-ProfileName
Specifies the AWS configuration profile. Configuration profiles are stored in
C:\Users\$User\.aws\config. If -ProfileName is not specified, the
AWS.Profile configuration variable will be used. If neither is
specified, an error will be thrown.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Project
Filter all instances by the value of a Project tag set on the instance. Instances that have no Project tag will not be included in the results.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Region
Specifies the AWS region identifier. For example, us-west-2 for the Oregon
region. If -Region is not specified, the AWS.Region configuration
variable will be used. If neither is specified, an error will be thrown.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Service
Specifies the AWS service to check for instances. The choices are EC2 (default) and Lightsail.
Type: Object
Parameter Sets: (All)
Aliases:
Accepted values: EC2, Lightsail
Required: False
Position: 3
Default value: EC2
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.