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 CodeGuru Reviewer CreateCodeReview API operation.

Syntax

New-CGRCodeReview
-Name <String>
-Type_AnalysisType <String[]>
-Type_RepositoryAnalysis_RepositoryHead_BranchName <String>
-Type_RepositoryAnalysis_SourceCodeType_RepositoryHead_BranchName <String>
-Details_BucketName <String>
-CodeArtifacts_BuildArtifactsObjectKey <String>
-ClientRequestToken <String>
-BranchDiff_DestinationBranchName <String>
-CommitDiff_DestinationCommit <String>
-CommitDiff_MergeBaseCommit <String>
-EventInfo_Name <String>
-S3BucketRepository_Name <String>
-RepositoryAssociationArn <String>
-RequestMetadata_Requester <String>
-RequestMetadata_RequestId <String>
-BranchDiff_SourceBranchName <String>
-CodeArtifacts_SourceCodeArtifactsObjectKey <String>
-CommitDiff_SourceCommit <String>
-EventInfo_State <String>
-RequestMetadata_VendorName <VendorName>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCodeGuruReviewerConfig>

Description

Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request.

Parameters

-BranchDiff_DestinationBranchName <String>
The destination branch for a diff in an associated repository.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_BranchDiff_DestinationBranchName
-BranchDiff_SourceBranchName <String>
The source branch for a diff in an associated repository.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_BranchDiff_SourceBranchName
-ClientConfig <AmazonCodeGuruReviewerConfig>
Amazon.PowerShell.Cmdlets.CGR.AmazonCodeGuruReviewerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CodeArtifacts_BuildArtifactsObjectKey <String>
The S3 object key for a build artifacts .zip file that contains .jar or .class files. This is required for a code review with security analysis. For more information, see Create code reviews with GitHub Actions in the Amazon CodeGuru Reviewer User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_S3BucketRepository_Details_CodeArtifacts_BuildArtifactsObjectKey
-CodeArtifacts_SourceCodeArtifactsObjectKey <String>
The S3 object key for a source code .zip file. This is required for all code reviews.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_S3BucketRepository_Details_CodeArtifacts_SourceCodeArtifactsObjectKey
-CommitDiff_DestinationCommit <String>
The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_CommitDiff_DestinationCommit
-CommitDiff_MergeBaseCommit <String>
The SHA of the merge base of a commit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_CommitDiff_MergeBaseCommit
-CommitDiff_SourceCommit <String>
The SHA of the source commit used to generate a commit diff. This field is required for a pull request code review.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_CommitDiff_SourceCommit
-Details_BucketName <String>
The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_S3BucketRepository_Details_BucketName
-EventInfo_Name <String>
The name of the event. The possible names are pull_request, workflow_dispatch, schedule, and push
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_RequestMetadata_EventInfo_Name
-EventInfo_State <String>
The state of an event. The state might be open, closed, or another state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_RequestMetadata_EventInfo_State
-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)
-Name <String>
The name of the code review. The name of each code review in your Amazon Web Services account must be unique.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-RepositoryAssociationArn <String>
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.A code review can only be created on an associated repository. This is the ARN of the associated repository.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequestMetadata_Requester <String>
An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_RequestMetadata_Requester
-RequestMetadata_RequestId <String>
The ID of the request. This is required for a pull request code review.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_RequestMetadata_RequestId
-RequestMetadata_VendorName <VendorName>
The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_RequestMetadata_VendorName
-S3BucketRepository_Name <String>
The name of the repository when the ProviderType is S3Bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesType_RepositoryAnalysis_SourceCodeType_S3BucketRepository_Name
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'CodeReview'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruReviewer.Model.CreateCodeReviewResponse). Specifying the name of a property of type Amazon.CodeGuruReviewer.Model.CreateCodeReviewResponse 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)
-Type_AnalysisType <String[]>
They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both. 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)
AliasesType_AnalysisTypes
-Type_RepositoryAnalysis_RepositoryHead_BranchName <String>
The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies the tip of this branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRepositoryHead_BranchName
-Type_RepositoryAnalysis_SourceCodeType_RepositoryHead_BranchName <String>
The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies the tip of this branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceCodeType_RepositoryHead_BranchName

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.CodeGuruReviewer.Model.CodeReview or Amazon.CodeGuruReviewer.Model.CreateCodeReviewResponse
This cmdlet returns an Amazon.CodeGuruReviewer.Model.CodeReview object. The service call response (type Amazon.CodeGuruReviewer.Model.CreateCodeReviewResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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