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 CodeDeploy GetApplicationRevision API operation.

Syntax

Get-CDApplicationRevision
-ApplicationName <String>
-S3Location_Bucket <String>
-S3Location_BundleType <BundleType>
-GitHubLocation_CommitId <String>
-AppSpecContent_Content <String>
-String_Content <String>
-S3Location_ETag <String>
-S3Location_Key <String>
-GitHubLocation_Repository <String>
-Revision_RevisionType <RevisionLocationType>
-AppSpecContent_Sha256 <String>
-String_Sha256 <String>
-S3Location_Version <String>
-Select <String>
-ClientConfig <AmazonCodeDeployConfig>

Description

Gets information about an application revision.

Parameters

-ApplicationName <String>
The name of the application that corresponds to the revision.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AppSpecContent_Content <String>
The YAML-formatted or JSON-formatted revision string. For an Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_AppSpecContent_Content
-AppSpecContent_Sha256 <String>
The SHA256 hash value of the revision content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_AppSpecContent_Sha256
-ClientConfig <AmazonCodeDeployConfig>
Amazon.PowerShell.Cmdlets.CD.AmazonCodeDeployClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GitHubLocation_CommitId <String>
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_GitHubLocation_CommitId
-GitHubLocation_Repository <String>
The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. Specified as account/repository.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_GitHubLocation_Repository
-Revision_RevisionType <RevisionLocationType>
The type of application revision:
  • S3: An application revision stored in Amazon S3.
  • GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
  • String: A YAML-formatted or JSON-formatted string (Lambda deployments only).
  • AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Location_Bucket <String>
The name of the Amazon S3 bucket where the application revision is stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_S3Location_Bucket
-S3Location_BundleType <BundleType>
The file type of the application revision. Must be one of the following:
  • tar: A tar archive file.
  • tgz: A compressed tar archive file.
  • zip: A zip archive file.
  • YAML: A YAML-formatted file.
  • JSON: A JSON-formatted file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_S3Location_BundleType
-S3Location_ETag <String>
The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.If the ETag is not specified as an input parameter, ETag validation of the object is skipped.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_S3Location_ETag
-S3Location_Key <String>
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_S3Location_Key
-S3Location_Version <String>
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.If the version is not specified, the system uses the most recent version by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_S3Location_Version
-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.CodeDeploy.Model.GetApplicationRevisionResponse). Specifying the name of a property of type Amazon.CodeDeploy.Model.GetApplicationRevisionResponse 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)
-String_Content <String>
The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_String_Content
-String_Sha256 <String>
The SHA256 hash value of the revision content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevision_String_Sha256

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.CodeDeploy.Model.GetApplicationRevisionResponse
This cmdlet returns an Amazon.CodeDeploy.Model.GetApplicationRevisionResponse object containing multiple properties.

Examples

Example 1

$revision = Get-CDApplicationRevision -ApplicationName CodeDeployDemoApplication -S3Location_Bucket amzn-s3-demo-bucket -Revision_RevisionType S3 -S3Location_Key 5xd27EX.zip -S3Location_BundleType zip -S3Location_ETag 4565c1ac97187f190c1a90265EXAMPLE
Write-Output ("Description = " + $revision.RevisionInfo.Description + ", RegisterTime = " + $revision.RevisionInfo.RegisterTime)

Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
This example gets information about the specified application revision.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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