CodeGuruReviewer

public struct CodeGuruReviewer

Client object for interacting with AWS CodeGuruReviewer service.

This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java code. By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the CodeGuruReviewer client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls

associateRepository(_:)
Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository’s pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide. If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured. Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in the Amazon CodeGuru Reviewer User Guide. You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.
Declaration
Swift

public func associateRepository(_ input: AssociateRepositoryRequest) -> EventLoopFuture<AssociateRepositoryResponse>


                    
                    
                    createCodeReview(_:)

Use to create a code review for a repository analysis.

Declaration

Swift

public func createCodeReview(_ input: CreateCodeReviewRequest) -> EventLoopFuture<CreateCodeReviewResponse>


                    
                    
                    describeCodeReview(_:)

Returns the metadata associated with the code review along with its status.

Declaration

Swift

public func describeCodeReview(_ input: DescribeCodeReviewRequest) -> EventLoopFuture<DescribeCodeReviewResponse>


                    
                    
                    describeRecommendationFeedback(_:)

Describes the customer feedback for a CodeGuru Reviewer recommendation.

Declaration

Swift

public func describeRecommendationFeedback(_ input: DescribeRecommendationFeedbackRequest) -> EventLoopFuture<DescribeRecommendationFeedbackResponse>

describeRepositoryAssociation(_:)
Returns a RepositoryAssociation object that contains information about the requested repository association.
Declaration
Swift

public func describeRepositoryAssociation(_ input: DescribeRepositoryAssociationRequest) -> EventLoopFuture<DescribeRepositoryAssociationResponse>


                    
                    
                    disassociateRepository(_:)

Removes the association between Amazon CodeGuru Reviewer and a repository.

Declaration

Swift

public func disassociateRepository(_ input: DisassociateRepositoryRequest) -> EventLoopFuture<DisassociateRepositoryResponse>

listCodeReviews(_:)
Lists all the code reviews that the customer has created in the past 90 days.
Declaration
Swift

public func listCodeReviews(_ input: ListCodeReviewsRequest) -> EventLoopFuture<ListCodeReviewsResponse>
listRecommendationFeedback(_:)
Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
Declaration
Swift

public func listRecommendationFeedback(_ input: ListRecommendationFeedbackRequest) -> EventLoopFuture<ListRecommendationFeedbackResponse>


                    
                    
                    listRecommendations(_:)

Returns the list of all recommendations for a completed code review.

Declaration

Swift

public func listRecommendations(_ input: ListRecommendationsRequest) -> EventLoopFuture<ListRecommendationsResponse>

listRepositoryAssociations(_:)
Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by ProviderType , Name , State , and Owner .
Declaration
Swift

public func listRepositoryAssociations(_ input: ListRepositoryAssociationsRequest) -> EventLoopFuture<ListRepositoryAssociationsResponse>
putRecommendationFeedback(_:)
Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
Declaration
Swift

public func putRecommendationFeedback(_ input: PutRecommendationFeedbackRequest) -> EventLoopFuture<PutRecommendationFeedbackResponse>

Paginators


                    
                    
                    listCodeReviewsPaginator(_:onPage:)

Lists all the code reviews that the customer has created in the past 90 days.

Declaration

Swift

public func listCodeReviewsPaginator(_ input: ListCodeReviewsRequest, onPage: @escaping (ListCodeReviewsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listRecommendationFeedbackPaginator(_:onPage:)

Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.

Declaration

Swift

public func listRecommendationFeedbackPaginator(_ input: ListRecommendationFeedbackRequest, onPage: @escaping (ListRecommendationFeedbackResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listRecommendationsPaginator(_:onPage:)

Returns the list of all recommendations for a completed code review.

Declaration

Swift

public func listRecommendationsPaginator(_ input: ListRecommendationsRequest, onPage: @escaping (ListRecommendationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

listRepositoryAssociationsPaginator(_:onPage:)
Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by ProviderType , Name , State , and Owner .
Declaration
Swift

public func listRepositoryAssociationsPaginator(_ input: ListRepositoryAssociationsRequest, onPage: @escaping (ListRepositoryAssociationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListCodeReviewsRequest

Undocumented

Declaration

Swift

public struct ListCodeReviewsRequest : AWSShape

extension CodeGuruReviewer.ListCodeReviewsRequest: AWSPaginateStringToken


                    
                    
                    ListRecommendationFeedbackRequest

Undocumented

Declaration

Swift

public struct ListRecommendationFeedbackRequest : AWSShape

extension CodeGuruReviewer.ListRecommendationFeedbackRequest: AWSPaginateStringToken


                    
                    
                    ListRecommendationsRequest

Undocumented

Declaration

Swift

public struct ListRecommendationsRequest : AWSShape

extension CodeGuruReviewer.ListRecommendationsRequest: AWSPaginateStringToken


                    
                    
                    ListRepositoryAssociationsRequest

Undocumented

Declaration

Swift

public struct ListRepositoryAssociationsRequest : AWSShape

extension CodeGuruReviewer.ListRepositoryAssociationsRequest: AWSPaginateStringToken

AssociateRepositoryRequest
Undocumented
See more
Declaration
Swift

public struct AssociateRepositoryRequest : AWSShape
AssociateRepositoryResponse
Undocumented
See more
Declaration
Swift

public struct AssociateRepositoryResponse : AWSShape
CodeCommitRepository
Undocumented
See more
Declaration
Swift

public struct CodeCommitRepository : AWSShape
CodeReview
Undocumented
See more
Declaration
Swift

public struct CodeReview : AWSShape
CodeReviewSummary
Undocumented
See more
Declaration
Swift

public struct CodeReviewSummary : AWSShape
CodeReviewType
Undocumented
See more
Declaration
Swift

public struct CodeReviewType : AWSShape
CommitDiffSourceCodeType
Undocumented
See more
Declaration
Swift

public struct CommitDiffSourceCodeType : AWSShape
CreateCodeReviewRequest
Undocumented
See more
Declaration
Swift

public struct CreateCodeReviewRequest : AWSShape
CreateCodeReviewResponse
Undocumented
See more
Declaration
Swift

public struct CreateCodeReviewResponse : AWSShape
DescribeCodeReviewRequest
Undocumented
See more
Declaration
Swift

public struct DescribeCodeReviewRequest : AWSShape
DescribeCodeReviewResponse
Undocumented
See more
Declaration
Swift

public struct DescribeCodeReviewResponse : AWSShape
DescribeRecommendationFeedbackRequest
Undocumented
See more
Declaration
Swift

public struct DescribeRecommendationFeedbackRequest : AWSShape
DescribeRecommendationFeedbackResponse
Undocumented
See more
Declaration
Swift

public struct DescribeRecommendationFeedbackResponse : AWSShape
DescribeRepositoryAssociationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeRepositoryAssociationRequest : AWSShape
DescribeRepositoryAssociationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeRepositoryAssociationResponse : AWSShape
DisassociateRepositoryRequest
Undocumented
See more
Declaration
Swift

public struct DisassociateRepositoryRequest : AWSShape
DisassociateRepositoryResponse
Undocumented
See more
Declaration
Swift

public struct DisassociateRepositoryResponse : AWSShape
ListCodeReviewsResponse
Undocumented
See more
Declaration
Swift

public struct ListCodeReviewsResponse : AWSShape
ListRecommendationFeedbackResponse
Undocumented
See more
Declaration
Swift

public struct ListRecommendationFeedbackResponse : AWSShape
ListRecommendationsResponse
Undocumented
See more
Declaration
Swift

public struct ListRecommendationsResponse : AWSShape
ListRepositoryAssociationsResponse
Undocumented
See more
Declaration
Swift

public struct ListRepositoryAssociationsResponse : AWSShape
Metrics
Undocumented
See more
Declaration
Swift

public struct Metrics : AWSShape
MetricsSummary
Undocumented
See more
Declaration
Swift

public struct MetricsSummary : AWSShape
PutRecommendationFeedbackRequest
Undocumented
See more
Declaration
Swift

public struct PutRecommendationFeedbackRequest : AWSShape
PutRecommendationFeedbackResponse
Undocumented
See more
Declaration
Swift

public struct PutRecommendationFeedbackResponse : AWSShape
RecommendationFeedback
Undocumented
See more
Declaration
Swift

public struct RecommendationFeedback : AWSShape
RecommendationFeedbackSummary
Undocumented
See more
Declaration
Swift

public struct RecommendationFeedbackSummary : AWSShape
RecommendationSummary
Undocumented
See more
Declaration
Swift

public struct RecommendationSummary : AWSShape
Repository
Undocumented
See more
Declaration
Swift

public struct Repository : AWSShape
RepositoryAnalysis
Undocumented
See more
Declaration
Swift

public struct RepositoryAnalysis : AWSShape
RepositoryAssociation
Undocumented
See more
Declaration
Swift

public struct RepositoryAssociation : AWSShape
RepositoryAssociationSummary
Undocumented
See more
Declaration
Swift

public struct RepositoryAssociationSummary : AWSShape
RepositoryHeadSourceCodeType
Undocumented
See more
Declaration
Swift

public struct RepositoryHeadSourceCodeType : AWSShape
SourceCodeType
Undocumented
See more
Declaration
Swift

public struct SourceCodeType : AWSShape
ThirdPartySourceRepository
Undocumented
See more
Declaration
Swift

public struct ThirdPartySourceRepository : AWSShape

Enums


                    
                    
                    JobState

Undocumented

Declaration

Swift

public enum JobState : String, CustomStringConvertible, Codable


                    
                    
                    ProviderType

Undocumented

Declaration

Swift

public enum ProviderType : String, CustomStringConvertible, Codable


                    
                    
                    Reaction

Undocumented

Declaration

Swift

public enum Reaction : String, CustomStringConvertible, Codable


                    
                    
                    RepositoryAssociationState

Undocumented

Declaration

Swift

public enum RepositoryAssociationState : String, CustomStringConvertible, Codable


                    
                    
                    Type

Undocumented

Declaration

Swift

public enum `Type` : String, CustomStringConvertible, Codable