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 Support API DescribeCases API operation.

Syntax

Get-ASACase
-CaseIdList <String[]>
-AfterTime <String>
-BeforeTime <String>
-DisplayId <String>
-IncludeCommunication <Boolean>
-IncludeResolvedCase <Boolean>
-Language <String>
-MaxResult <Int32>
-NextToken <String>

Description

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. The response returns the following in JSON format:
  • One or more CaseDetails data types.
  • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.


This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.

Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias, Get-ASACases.

Parameters

-AfterTime <String>
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
Required?False
Position?Named
Accept pipeline input?False
-BeforeTime <String>
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
Required?False
Position?Named
Accept pipeline input?False
-CaseIdList <String[]>
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-DisplayId <String>
The ID displayed for a case in the AWS Support Center user interface.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncludeCommunication <Boolean>
Specifies whether communications should be included in the DescribeCases results. The default is true.
Required?False
Position?Named
Accept pipeline input?False
-IncludeResolvedCase <Boolean>
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
Required?False
Position?Named
Accept pipeline input?False
-Language <String>
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Required?False
Position?Named
Accept pipeline input?False
-MaxResult <Int32>
The maximum number of results to return before paginating.
Required?False
Position?Named
Accept pipeline input?False
-NextToken <String>
A resumption point for pagination.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String[] object to this cmdlet for the CaseIdList parameter.

Outputs

This cmdlet returns a collection of CaseDetails objects. The service call response (type Amazon.AWSSupport.Model.DescribeCasesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)

Examples

Example 1

PS C:\>Get-ASACase
Returns the details of all support cases.

Example 2

PS C:\>Get-ASACase -AfterTime "2013-09-10T03:06Z"
Returns the details of all support cases since the specified date and time.

Example 3

PS C:\>Get-ASACase -MaxResult 10 -IncludeResolvedCases $true
Returns the details of the first 10 support cases, including those that have been resolved.

Example 4

PS C:\>Get-ASACase -CaseIdList "case-12345678910-2013-c4c1d2bf33c5cf47"
Returns the details of the single specified support case.

Example 5

PS C:\>Get-ASACase -CaseIdList @("case-12345678910-2013-c4c1d2bf33c5cf47", "case-18929034710-2011-c4fdeabf33c5cf47")
Returns the details of specified support cases.

Example 6

$nextToken = $null
do {
Get-ASACase -NextToken $nextToken -MaxResult 20
$nextToken = $AWSHistory.LastServiceResponse.NextToken
} while ($nextToken -ne $null)
Returns all support cases using manual paging. The cases are retrieved in batches of 20.

Supported Version

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