/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / codegurureviewer.d.ts
codegurureviewer.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare class CodeGuruReviewer extends Service { 10 /** 11 * Constructs a service object. This object has one method for each API operation. 12 */ 13 constructor(options?: CodeGuruReviewer.Types.ClientConfiguration) 14 config: Config & CodeGuruReviewer.Types.ClientConfiguration; 15 /** 16 * 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 or S3 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 Associate a repository 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. 17 */ 18 associateRepository(params: CodeGuruReviewer.Types.AssociateRepositoryRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.AssociateRepositoryResponse) => void): Request<CodeGuruReviewer.Types.AssociateRepositoryResponse, AWSError>; 19 /** 20 * 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 or S3 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 Associate a repository 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. 21 */ 22 associateRepository(callback?: (err: AWSError, data: CodeGuruReviewer.Types.AssociateRepositoryResponse) => void): Request<CodeGuruReviewer.Types.AssociateRepositoryResponse, AWSError>; 23 /** 24 * 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. 25 */ 26 createCodeReview(params: CodeGuruReviewer.Types.CreateCodeReviewRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.CreateCodeReviewResponse) => void): Request<CodeGuruReviewer.Types.CreateCodeReviewResponse, AWSError>; 27 /** 28 * 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. 29 */ 30 createCodeReview(callback?: (err: AWSError, data: CodeGuruReviewer.Types.CreateCodeReviewResponse) => void): Request<CodeGuruReviewer.Types.CreateCodeReviewResponse, AWSError>; 31 /** 32 * Returns the metadata associated with the code review along with its status. 33 */ 34 describeCodeReview(params: CodeGuruReviewer.Types.DescribeCodeReviewRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeCodeReviewResponse) => void): Request<CodeGuruReviewer.Types.DescribeCodeReviewResponse, AWSError>; 35 /** 36 * Returns the metadata associated with the code review along with its status. 37 */ 38 describeCodeReview(callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeCodeReviewResponse) => void): Request<CodeGuruReviewer.Types.DescribeCodeReviewResponse, AWSError>; 39 /** 40 * Describes the customer feedback for a CodeGuru Reviewer recommendation. 41 */ 42 describeRecommendationFeedback(params: CodeGuruReviewer.Types.DescribeRecommendationFeedbackRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeRecommendationFeedbackResponse) => void): Request<CodeGuruReviewer.Types.DescribeRecommendationFeedbackResponse, AWSError>; 43 /** 44 * Describes the customer feedback for a CodeGuru Reviewer recommendation. 45 */ 46 describeRecommendationFeedback(callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeRecommendationFeedbackResponse) => void): Request<CodeGuruReviewer.Types.DescribeRecommendationFeedbackResponse, AWSError>; 47 /** 48 * Returns a RepositoryAssociation object that contains information about the requested repository association. 49 */ 50 describeRepositoryAssociation(params: CodeGuruReviewer.Types.DescribeRepositoryAssociationRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse) => void): Request<CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse, AWSError>; 51 /** 52 * Returns a RepositoryAssociation object that contains information about the requested repository association. 53 */ 54 describeRepositoryAssociation(callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse) => void): Request<CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse, AWSError>; 55 /** 56 * Removes the association between Amazon CodeGuru Reviewer and a repository. 57 */ 58 disassociateRepository(params: CodeGuruReviewer.Types.DisassociateRepositoryRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.DisassociateRepositoryResponse) => void): Request<CodeGuruReviewer.Types.DisassociateRepositoryResponse, AWSError>; 59 /** 60 * Removes the association between Amazon CodeGuru Reviewer and a repository. 61 */ 62 disassociateRepository(callback?: (err: AWSError, data: CodeGuruReviewer.Types.DisassociateRepositoryResponse) => void): Request<CodeGuruReviewer.Types.DisassociateRepositoryResponse, AWSError>; 63 /** 64 * Lists all the code reviews that the customer has created in the past 90 days. 65 */ 66 listCodeReviews(params: CodeGuruReviewer.Types.ListCodeReviewsRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListCodeReviewsResponse) => void): Request<CodeGuruReviewer.Types.ListCodeReviewsResponse, AWSError>; 67 /** 68 * Lists all the code reviews that the customer has created in the past 90 days. 69 */ 70 listCodeReviews(callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListCodeReviewsResponse) => void): Request<CodeGuruReviewer.Types.ListCodeReviewsResponse, AWSError>; 71 /** 72 * Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users. 73 */ 74 listRecommendationFeedback(params: CodeGuruReviewer.Types.ListRecommendationFeedbackRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListRecommendationFeedbackResponse) => void): Request<CodeGuruReviewer.Types.ListRecommendationFeedbackResponse, AWSError>; 75 /** 76 * Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users. 77 */ 78 listRecommendationFeedback(callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListRecommendationFeedbackResponse) => void): Request<CodeGuruReviewer.Types.ListRecommendationFeedbackResponse, AWSError>; 79 /** 80 * Returns the list of all recommendations for a completed code review. 81 */ 82 listRecommendations(params: CodeGuruReviewer.Types.ListRecommendationsRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListRecommendationsResponse) => void): Request<CodeGuruReviewer.Types.ListRecommendationsResponse, AWSError>; 83 /** 84 * Returns the list of all recommendations for a completed code review. 85 */ 86 listRecommendations(callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListRecommendationsResponse) => void): Request<CodeGuruReviewer.Types.ListRecommendationsResponse, AWSError>; 87 /** 88 * 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 . 89 */ 90 listRepositoryAssociations(params: CodeGuruReviewer.Types.ListRepositoryAssociationsRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListRepositoryAssociationsResponse) => void): Request<CodeGuruReviewer.Types.ListRepositoryAssociationsResponse, AWSError>; 91 /** 92 * 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 . 93 */ 94 listRepositoryAssociations(callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListRepositoryAssociationsResponse) => void): Request<CodeGuruReviewer.Types.ListRepositoryAssociationsResponse, AWSError>; 95 /** 96 * Returns the list of tags associated with an associated repository resource. 97 */ 98 listTagsForResource(params: CodeGuruReviewer.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListTagsForResourceResponse) => void): Request<CodeGuruReviewer.Types.ListTagsForResourceResponse, AWSError>; 99 /** 100 * Returns the list of tags associated with an associated repository resource. 101 */ 102 listTagsForResource(callback?: (err: AWSError, data: CodeGuruReviewer.Types.ListTagsForResourceResponse) => void): Request<CodeGuruReviewer.Types.ListTagsForResourceResponse, AWSError>; 103 /** 104 * Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. 105 */ 106 putRecommendationFeedback(params: CodeGuruReviewer.Types.PutRecommendationFeedbackRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.PutRecommendationFeedbackResponse) => void): Request<CodeGuruReviewer.Types.PutRecommendationFeedbackResponse, AWSError>; 107 /** 108 * Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. 109 */ 110 putRecommendationFeedback(callback?: (err: AWSError, data: CodeGuruReviewer.Types.PutRecommendationFeedbackResponse) => void): Request<CodeGuruReviewer.Types.PutRecommendationFeedbackResponse, AWSError>; 111 /** 112 * Adds one or more tags to an associated repository. 113 */ 114 tagResource(params: CodeGuruReviewer.Types.TagResourceRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.TagResourceResponse) => void): Request<CodeGuruReviewer.Types.TagResourceResponse, AWSError>; 115 /** 116 * Adds one or more tags to an associated repository. 117 */ 118 tagResource(callback?: (err: AWSError, data: CodeGuruReviewer.Types.TagResourceResponse) => void): Request<CodeGuruReviewer.Types.TagResourceResponse, AWSError>; 119 /** 120 * Removes a tag from an associated repository. 121 */ 122 untagResource(params: CodeGuruReviewer.Types.UntagResourceRequest, callback?: (err: AWSError, data: CodeGuruReviewer.Types.UntagResourceResponse) => void): Request<CodeGuruReviewer.Types.UntagResourceResponse, AWSError>; 123 /** 124 * Removes a tag from an associated repository. 125 */ 126 untagResource(callback?: (err: AWSError, data: CodeGuruReviewer.Types.UntagResourceResponse) => void): Request<CodeGuruReviewer.Types.UntagResourceResponse, AWSError>; 127 /** 128 * Waits for the repositoryAssociationSucceeded state by periodically calling the underlying CodeGuruReviewer.describeRepositoryAssociationoperation every 10 seconds (at most 20 times). Wait until a repository association is complete. 129 */ 130 waitFor(state: "repositoryAssociationSucceeded", params: CodeGuruReviewer.Types.DescribeRepositoryAssociationRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse) => void): Request<CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse, AWSError>; 131 /** 132 * Waits for the repositoryAssociationSucceeded state by periodically calling the underlying CodeGuruReviewer.describeRepositoryAssociationoperation every 10 seconds (at most 20 times). Wait until a repository association is complete. 133 */ 134 waitFor(state: "repositoryAssociationSucceeded", callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse) => void): Request<CodeGuruReviewer.Types.DescribeRepositoryAssociationResponse, AWSError>; 135 /** 136 * Waits for the codeReviewCompleted state by periodically calling the underlying CodeGuruReviewer.describeCodeReviewoperation every 10 seconds (at most 60 times). Wait until a code review is complete. 137 */ 138 waitFor(state: "codeReviewCompleted", params: CodeGuruReviewer.Types.DescribeCodeReviewRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeCodeReviewResponse) => void): Request<CodeGuruReviewer.Types.DescribeCodeReviewResponse, AWSError>; 139 /** 140 * Waits for the codeReviewCompleted state by periodically calling the underlying CodeGuruReviewer.describeCodeReviewoperation every 10 seconds (at most 60 times). Wait until a code review is complete. 141 */ 142 waitFor(state: "codeReviewCompleted", callback?: (err: AWSError, data: CodeGuruReviewer.Types.DescribeCodeReviewResponse) => void): Request<CodeGuruReviewer.Types.DescribeCodeReviewResponse, AWSError>; 143 } 144 declare namespace CodeGuruReviewer { 145 export type AnalysisType = "Security"|"CodeQuality"|string; 146 export type AnalysisTypes = AnalysisType[]; 147 export type Arn = string; 148 export interface AssociateRepositoryRequest { 149 /** 150 * The repository to associate. 151 */ 152 Repository: Repository; 153 /** 154 * Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries. 155 */ 156 ClientRequestToken?: ClientRequestToken; 157 /** 158 * An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive. An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive. 159 */ 160 Tags?: TagMap; 161 /** 162 * A KMSKeyDetails object that contains: The encryption option for this repository association. It is either owned by AWS Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). The ID of the AWS KMS key that is associated with this respository association. 163 */ 164 KMSKeyDetails?: KMSKeyDetails; 165 } 166 export interface AssociateRepositoryResponse { 167 /** 168 * Information about the repository association. 169 */ 170 RepositoryAssociation?: RepositoryAssociation; 171 /** 172 * An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive. An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive. 173 */ 174 Tags?: TagMap; 175 } 176 export type AssociationArn = string; 177 export type AssociationId = string; 178 export interface BranchDiffSourceCodeType { 179 /** 180 * The source branch for a diff in an associated repository. 181 */ 182 SourceBranchName: BranchName; 183 /** 184 * The destination branch for a diff in an associated repository. 185 */ 186 DestinationBranchName: BranchName; 187 } 188 export type BranchName = string; 189 export type BuildArtifactsObjectKey = string; 190 export type ClientRequestToken = string; 191 export interface CodeArtifacts { 192 /** 193 * The S3 object key for a source code .zip file. This is required for all code reviews. 194 */ 195 SourceCodeArtifactsObjectKey: SourceCodeArtifactsObjectKey; 196 /** 197 * 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 security analysis in the Amazon CodeGuru Reviewer User Guide. 198 */ 199 BuildArtifactsObjectKey?: BuildArtifactsObjectKey; 200 } 201 export interface CodeCommitRepository { 202 /** 203 * The name of the AWS CodeCommit repository. For more information, see repositoryName in the AWS CodeCommit API Reference. 204 */ 205 Name: Name; 206 } 207 export interface CodeReview { 208 /** 209 * The name of the code review. 210 */ 211 Name?: Name; 212 /** 213 * The Amazon Resource Name (ARN) of the CodeReview object. 214 */ 215 CodeReviewArn?: Arn; 216 /** 217 * The name of the repository. 218 */ 219 RepositoryName?: Name; 220 /** 221 * The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID. 222 */ 223 Owner?: Owner; 224 /** 225 * The type of repository that contains the reviewed code (for example, GitHub or Bitbucket). 226 */ 227 ProviderType?: ProviderType; 228 /** 229 * The valid code review states are: Completed: The code review is complete. Pending: The code review started and has not completed or failed. Failed: The code review failed. Deleting: The code review is being deleted. 230 */ 231 State?: JobState; 232 /** 233 * The reason for the state of the code review. 234 */ 235 StateReason?: StateReason; 236 /** 237 * The time, in milliseconds since the epoch, when the code review was created. 238 */ 239 CreatedTimeStamp?: TimeStamp; 240 /** 241 * The time, in milliseconds since the epoch, when the code review was last updated. 242 */ 243 LastUpdatedTimeStamp?: TimeStamp; 244 /** 245 * The type of code review. 246 */ 247 Type?: Type; 248 /** 249 * The pull request ID for the code review. 250 */ 251 PullRequestId?: PullRequestId; 252 /** 253 * The type of the source code for the code review. 254 */ 255 SourceCodeType?: SourceCodeType; 256 /** 257 * The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations . 258 */ 259 AssociationArn?: AssociationArn; 260 /** 261 * The statistics from the code review. 262 */ 263 Metrics?: Metrics; 264 /** 265 * They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both. 266 */ 267 AnalysisTypes?: AnalysisTypes; 268 } 269 export type CodeReviewName = string; 270 export type CodeReviewSummaries = CodeReviewSummary[]; 271 export interface CodeReviewSummary { 272 /** 273 * The name of the code review. 274 */ 275 Name?: Name; 276 /** 277 * The Amazon Resource Name (ARN) of the CodeReview object. 278 */ 279 CodeReviewArn?: Arn; 280 /** 281 * The name of the repository. 282 */ 283 RepositoryName?: Name; 284 /** 285 * The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID. 286 */ 287 Owner?: Owner; 288 /** 289 * The provider type of the repository association. 290 */ 291 ProviderType?: ProviderType; 292 /** 293 * The state of the code review. The valid code review states are: Completed: The code review is complete. Pending: The code review started and has not completed or failed. Failed: The code review failed. Deleting: The code review is being deleted. 294 */ 295 State?: JobState; 296 /** 297 * The time, in milliseconds since the epoch, when the code review was created. 298 */ 299 CreatedTimeStamp?: TimeStamp; 300 /** 301 * The time, in milliseconds since the epoch, when the code review was last updated. 302 */ 303 LastUpdatedTimeStamp?: TimeStamp; 304 /** 305 * The type of the code review. 306 */ 307 Type?: Type; 308 /** 309 * The pull request ID for the code review. 310 */ 311 PullRequestId?: PullRequestId; 312 /** 313 * The statistics from the code review. 314 */ 315 MetricsSummary?: MetricsSummary; 316 SourceCodeType?: SourceCodeType; 317 } 318 export interface CodeReviewType { 319 /** 320 * A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview . 321 */ 322 RepositoryAnalysis: RepositoryAnalysis; 323 /** 324 * They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both. 325 */ 326 AnalysisTypes?: AnalysisTypes; 327 } 328 export interface CommitDiffSourceCodeType { 329 /** 330 * The SHA of the source commit used to generate a commit diff. This field is required for a pull request code review. 331 */ 332 SourceCommit?: CommitId; 333 /** 334 * The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review. 335 */ 336 DestinationCommit?: CommitId; 337 /** 338 * The SHA of the merge base of a commit. 339 */ 340 MergeBaseCommit?: CommitId; 341 } 342 export type CommitId = string; 343 export type ConnectionArn = string; 344 export interface CreateCodeReviewRequest { 345 /** 346 * The name of the code review. The name of each code review in your AWS account must be unique. 347 */ 348 Name: CodeReviewName; 349 /** 350 * 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. 351 */ 352 RepositoryAssociationArn: AssociationArn; 353 /** 354 * The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of type RepositoryAnalysis. 355 */ 356 Type: CodeReviewType; 357 /** 358 * Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries. 359 */ 360 ClientRequestToken?: ClientRequestToken; 361 } 362 export interface CreateCodeReviewResponse { 363 CodeReview?: CodeReview; 364 } 365 export interface DescribeCodeReviewRequest { 366 /** 367 * The Amazon Resource Name (ARN) of the CodeReview object. 368 */ 369 CodeReviewArn: Arn; 370 } 371 export interface DescribeCodeReviewResponse { 372 /** 373 * Information about the code review. 374 */ 375 CodeReview?: CodeReview; 376 } 377 export interface DescribeRecommendationFeedbackRequest { 378 /** 379 * The Amazon Resource Name (ARN) of the CodeReview object. 380 */ 381 CodeReviewArn: Arn; 382 /** 383 * The recommendation ID that can be used to track the provided recommendations and then to collect the feedback. 384 */ 385 RecommendationId: RecommendationId; 386 /** 387 * Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request. The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide. 388 */ 389 UserId?: UserId; 390 } 391 export interface DescribeRecommendationFeedbackResponse { 392 /** 393 * The recommendation feedback given by the user. 394 */ 395 RecommendationFeedback?: RecommendationFeedback; 396 } 397 export interface DescribeRepositoryAssociationRequest { 398 /** 399 * The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations . 400 */ 401 AssociationArn: AssociationArn; 402 } 403 export interface DescribeRepositoryAssociationResponse { 404 /** 405 * Information about the repository association. 406 */ 407 RepositoryAssociation?: RepositoryAssociation; 408 /** 409 * An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive. An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive. 410 */ 411 Tags?: TagMap; 412 } 413 export interface DisassociateRepositoryRequest { 414 /** 415 * The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations . 416 */ 417 AssociationArn: AssociationArn; 418 } 419 export interface DisassociateRepositoryResponse { 420 /** 421 * Information about the disassociated repository. 422 */ 423 RepositoryAssociation?: RepositoryAssociation; 424 /** 425 * An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive. An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive. 426 */ 427 Tags?: TagMap; 428 } 429 export type EncryptionOption = "AWS_OWNED_CMK"|"CUSTOMER_MANAGED_CMK"|string; 430 export interface EventInfo { 431 /** 432 * The name of the event. The possible names are pull_request, workflow_dispatch, schedule, and push 433 */ 434 Name?: EventName; 435 /** 436 * The state of an event. The state might be open, closed, or another state. 437 */ 438 State?: EventState; 439 } 440 export type EventName = string; 441 export type EventState = string; 442 export type FilePath = string; 443 export type FindingsCount = number; 444 export type JobState = "Completed"|"Pending"|"Failed"|"Deleting"|string; 445 export type JobStates = JobState[]; 446 export interface KMSKeyDetails { 447 /** 448 * The ID of the AWS KMS key that is associated with a respository association. 449 */ 450 KMSKeyId?: KMSKeyId; 451 /** 452 * The encryption option for a repository association. It is either owned by AWS Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). 453 */ 454 EncryptionOption?: EncryptionOption; 455 } 456 export type KMSKeyId = string; 457 export type LineNumber = number; 458 export type ListCodeReviewsMaxResults = number; 459 export interface ListCodeReviewsRequest { 460 /** 461 * List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub. 462 */ 463 ProviderTypes?: ProviderTypes; 464 /** 465 * List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state. The valid code review states are: Completed: The code review is complete. Pending: The code review started and has not completed or failed. Failed: The code review failed. Deleting: The code review is being deleted. 466 */ 467 States?: JobStates; 468 /** 469 * List of repository names for filtering that needs to be applied before displaying the result. 470 */ 471 RepositoryNames?: RepositoryNames; 472 /** 473 * The type of code reviews to list in the response. 474 */ 475 Type: Type; 476 /** 477 * The maximum number of results that are returned per call. The default is 100. 478 */ 479 MaxResults?: ListCodeReviewsMaxResults; 480 /** 481 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. 482 */ 483 NextToken?: NextToken; 484 } 485 export interface ListCodeReviewsResponse { 486 /** 487 * A list of code reviews that meet the criteria of the request. 488 */ 489 CodeReviewSummaries?: CodeReviewSummaries; 490 /** 491 * Pagination token. 492 */ 493 NextToken?: NextToken; 494 } 495 export interface ListRecommendationFeedbackRequest { 496 /** 497 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. 498 */ 499 NextToken?: NextToken; 500 /** 501 * The maximum number of results that are returned per call. The default is 100. 502 */ 503 MaxResults?: MaxResults; 504 /** 505 * The Amazon Resource Name (ARN) of the CodeReview object. 506 */ 507 CodeReviewArn: Arn; 508 /** 509 * An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user. The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide. 510 */ 511 UserIds?: UserIds; 512 /** 513 * Used to query the recommendation feedback for a given recommendation. 514 */ 515 RecommendationIds?: RecommendationIds; 516 } 517 export interface ListRecommendationFeedbackResponse { 518 /** 519 * Recommendation feedback summaries corresponding to the code review ARN. 520 */ 521 RecommendationFeedbackSummaries?: RecommendationFeedbackSummaries; 522 /** 523 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. 524 */ 525 NextToken?: NextToken; 526 } 527 export interface ListRecommendationsRequest { 528 /** 529 * Pagination token. 530 */ 531 NextToken?: NextToken; 532 /** 533 * The maximum number of results that are returned per call. The default is 100. 534 */ 535 MaxResults?: MaxResults; 536 /** 537 * The Amazon Resource Name (ARN) of the CodeReview object. 538 */ 539 CodeReviewArn: Arn; 540 } 541 export interface ListRecommendationsResponse { 542 /** 543 * List of recommendations for the requested code review. 544 */ 545 RecommendationSummaries?: RecommendationSummaries; 546 /** 547 * Pagination token. 548 */ 549 NextToken?: NextToken; 550 } 551 export interface ListRepositoryAssociationsRequest { 552 /** 553 * List of provider types to use as a filter. 554 */ 555 ProviderTypes?: ProviderTypes; 556 /** 557 * List of repository association states to use as a filter. The valid repository association states are: Associated: The repository association is complete. Associating: CodeGuru Reviewer is: Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review. If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered. Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository. Failed: The repository failed to associate or disassociate. Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access. Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in an associated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide. 558 */ 559 States?: RepositoryAssociationStates; 560 /** 561 * List of repository names to use as a filter. 562 */ 563 Names?: Names; 564 /** 565 * List of owners to use as a filter. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that was used to associate the repository. 566 */ 567 Owners?: Owners; 568 /** 569 * The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable. 570 */ 571 MaxResults?: MaxResults; 572 /** 573 * The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. 574 */ 575 NextToken?: NextToken; 576 } 577 export interface ListRepositoryAssociationsResponse { 578 /** 579 * A list of repository associations that meet the criteria of the request. 580 */ 581 RepositoryAssociationSummaries?: RepositoryAssociationSummaries; 582 /** 583 * The nextToken value to include in a future ListRecommendations request. When the results of a ListRecommendations request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. 584 */ 585 NextToken?: NextToken; 586 } 587 export interface ListTagsForResourceRequest { 588 /** 589 * The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations . 590 */ 591 resourceArn: AssociationArn; 592 } 593 export interface ListTagsForResourceResponse { 594 /** 595 * An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive. An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive. 596 */ 597 Tags?: TagMap; 598 } 599 export type MaxResults = number; 600 export type MeteredLinesOfCodeCount = number; 601 export interface Metrics { 602 /** 603 * Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code. 604 */ 605 MeteredLinesOfCodeCount?: MeteredLinesOfCodeCount; 606 /** 607 * Total number of recommendations found in the code review. 608 */ 609 FindingsCount?: FindingsCount; 610 } 611 export interface MetricsSummary { 612 /** 613 * Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code. 614 */ 615 MeteredLinesOfCodeCount?: MeteredLinesOfCodeCount; 616 /** 617 * Total number of recommendations found in the code review. 618 */ 619 FindingsCount?: FindingsCount; 620 } 621 export type Name = string; 622 export type Names = Name[]; 623 export type NextToken = string; 624 export type Owner = string; 625 export type Owners = Owner[]; 626 export type ProviderType = "CodeCommit"|"GitHub"|"Bitbucket"|"GitHubEnterpriseServer"|"S3Bucket"|string; 627 export type ProviderTypes = ProviderType[]; 628 export type PullRequestId = string; 629 export interface PutRecommendationFeedbackRequest { 630 /** 631 * The Amazon Resource Name (ARN) of the CodeReview object. 632 */ 633 CodeReviewArn: Arn; 634 /** 635 * The recommendation ID that can be used to track the provided recommendations and then to collect the feedback. 636 */ 637 RecommendationId: RecommendationId; 638 /** 639 * List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback. 640 */ 641 Reactions: Reactions; 642 } 643 export interface PutRecommendationFeedbackResponse { 644 } 645 export type Reaction = "ThumbsUp"|"ThumbsDown"|string; 646 export type Reactions = Reaction[]; 647 export type RecommendationCategory = "AWSBestPractices"|"AWSCloudFormationIssues"|"DuplicateCode"|"CodeMaintenanceIssues"|"ConcurrencyIssues"|"InputValidations"|"PythonBestPractices"|"JavaBestPractices"|"ResourceLeaks"|"SecurityIssues"|string; 648 export interface RecommendationFeedback { 649 /** 650 * The Amazon Resource Name (ARN) of the CodeReview object. 651 */ 652 CodeReviewArn?: Arn; 653 /** 654 * The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. 655 */ 656 RecommendationId?: RecommendationId; 657 /** 658 * List for storing reactions. Reactions are utf-8 text code for emojis. You can send an empty list to clear off all your feedback. 659 */ 660 Reactions?: Reactions; 661 /** 662 * The ID of the user that made the API call. The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide. 663 */ 664 UserId?: UserId; 665 /** 666 * The time at which the feedback was created. 667 */ 668 CreatedTimeStamp?: TimeStamp; 669 /** 670 * The time at which the feedback was last updated. 671 */ 672 LastUpdatedTimeStamp?: TimeStamp; 673 } 674 export type RecommendationFeedbackSummaries = RecommendationFeedbackSummary[]; 675 export interface RecommendationFeedbackSummary { 676 /** 677 * The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. 678 */ 679 RecommendationId?: RecommendationId; 680 /** 681 * List for storing reactions. Reactions are utf-8 text code for emojis. 682 */ 683 Reactions?: Reactions; 684 /** 685 * The ID of the user that gave the feedback. The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide. 686 */ 687 UserId?: UserId; 688 } 689 export type RecommendationId = string; 690 export type RecommendationIds = RecommendationId[]; 691 export type RecommendationSummaries = RecommendationSummary[]; 692 export interface RecommendationSummary { 693 /** 694 * Name of the file on which a recommendation is provided. 695 */ 696 FilePath?: FilePath; 697 /** 698 * The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. 699 */ 700 RecommendationId?: RecommendationId; 701 /** 702 * Start line from where the recommendation is applicable in the source commit or source branch. 703 */ 704 StartLine?: LineNumber; 705 /** 706 * Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same. 707 */ 708 EndLine?: LineNumber; 709 /** 710 * A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line. 711 */ 712 Description?: Text; 713 /** 714 * The type of a recommendation. 715 */ 716 RecommendationCategory?: RecommendationCategory; 717 } 718 export interface Repository { 719 /** 720 * Information about an AWS CodeCommit repository. 721 */ 722 CodeCommit?: CodeCommitRepository; 723 /** 724 * Information about a Bitbucket repository. 725 */ 726 Bitbucket?: ThirdPartySourceRepository; 727 /** 728 * Information about a GitHub Enterprise Server repository. 729 */ 730 GitHubEnterpriseServer?: ThirdPartySourceRepository; 731 S3Bucket?: S3Repository; 732 } 733 export interface RepositoryAnalysis { 734 /** 735 * A SourceCodeType that specifies the tip of a branch in an associated repository. 736 */ 737 RepositoryHead?: RepositoryHeadSourceCodeType; 738 SourceCodeType?: SourceCodeType; 739 } 740 export interface RepositoryAssociation { 741 /** 742 * The ID of the repository association. 743 */ 744 AssociationId?: AssociationId; 745 /** 746 * The Amazon Resource Name (ARN) identifying the repository association. 747 */ 748 AssociationArn?: Arn; 749 /** 750 * The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the AWS CodeStar Connections API Reference. 751 */ 752 ConnectionArn?: ConnectionArn; 753 /** 754 * The name of the repository. 755 */ 756 Name?: Name; 757 /** 758 * The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID. 759 */ 760 Owner?: Owner; 761 /** 762 * The provider type of the repository association. 763 */ 764 ProviderType?: ProviderType; 765 /** 766 * The state of the repository association. The valid repository association states are: Associated: The repository association is complete. Associating: CodeGuru Reviewer is: Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review. If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered. Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository. Failed: The repository failed to associate or disassociate. Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access. Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in an associated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide. 767 */ 768 State?: RepositoryAssociationState; 769 /** 770 * A description of why the repository association is in the current state. 771 */ 772 StateReason?: StateReason; 773 /** 774 * The time, in milliseconds since the epoch, when the repository association was last updated. 775 */ 776 LastUpdatedTimeStamp?: TimeStamp; 777 /** 778 * The time, in milliseconds since the epoch, when the repository association was created. 779 */ 780 CreatedTimeStamp?: TimeStamp; 781 /** 782 * A KMSKeyDetails object that contains: The encryption option for this repository association. It is either owned by AWS Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). The ID of the AWS KMS key that is associated with this respository association. 783 */ 784 KMSKeyDetails?: KMSKeyDetails; 785 S3RepositoryDetails?: S3RepositoryDetails; 786 } 787 export type RepositoryAssociationState = "Associated"|"Associating"|"Failed"|"Disassociating"|"Disassociated"|string; 788 export type RepositoryAssociationStates = RepositoryAssociationState[]; 789 export type RepositoryAssociationSummaries = RepositoryAssociationSummary[]; 790 export interface RepositoryAssociationSummary { 791 /** 792 * The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations . 793 */ 794 AssociationArn?: Arn; 795 /** 796 * The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the AWS CodeStar Connections API Reference. 797 */ 798 ConnectionArn?: ConnectionArn; 799 /** 800 * The time, in milliseconds since the epoch, since the repository association was last updated. 801 */ 802 LastUpdatedTimeStamp?: TimeStamp; 803 /** 804 * The repository association ID. 805 */ 806 AssociationId?: AssociationId; 807 /** 808 * The name of the repository association. 809 */ 810 Name?: Name; 811 /** 812 * The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID. 813 */ 814 Owner?: Owner; 815 /** 816 * The provider type of the repository association. 817 */ 818 ProviderType?: ProviderType; 819 /** 820 * The state of the repository association. The valid repository association states are: Associated: The repository association is complete. Associating: CodeGuru Reviewer is: Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review. If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered. Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository. Failed: The repository failed to associate or disassociate. Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access. Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in an associated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide. 821 */ 822 State?: RepositoryAssociationState; 823 } 824 export interface RepositoryHeadSourceCodeType { 825 /** 826 * The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies the tip of this branch. 827 */ 828 BranchName: BranchName; 829 } 830 export type RepositoryNames = Name[]; 831 export type RequestId = string; 832 export interface RequestMetadata { 833 /** 834 * The ID of the request. This is required for a pull request code review. 835 */ 836 RequestId?: RequestId; 837 /** 838 * 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. 839 */ 840 Requester?: Requester; 841 /** 842 * Information about the event associated with a code review. 843 */ 844 EventInfo?: EventInfo; 845 /** 846 * 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. 847 */ 848 VendorName?: VendorName; 849 } 850 export type Requester = string; 851 export type S3BucketName = string; 852 export interface S3BucketRepository { 853 /** 854 * The name of the repository when the ProviderType is S3Bucket. 855 */ 856 Name: Name; 857 /** 858 * An S3RepositoryDetails object that specifies the name of an S3 bucket and a CodeArtifacts object. The CodeArtifacts object includes the S3 object keys for a source code .zip file and for a build artifacts .zip file. 859 */ 860 Details?: S3RepositoryDetails; 861 } 862 export interface S3Repository { 863 /** 864 * The name of the repository in the S3 bucket. 865 */ 866 Name: Name; 867 /** 868 * The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-. 869 */ 870 BucketName: S3BucketName; 871 } 872 export interface S3RepositoryDetails { 873 /** 874 * The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-. 875 */ 876 BucketName?: S3BucketName; 877 /** 878 * A CodeArtifacts object. The CodeArtifacts object includes the S3 object key for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files. 879 */ 880 CodeArtifacts?: CodeArtifacts; 881 } 882 export type SourceCodeArtifactsObjectKey = string; 883 export interface SourceCodeType { 884 /** 885 * A SourceCodeType that specifies a commit diff created by a pull request on an associated repository. 886 */ 887 CommitDiff?: CommitDiffSourceCodeType; 888 RepositoryHead?: RepositoryHeadSourceCodeType; 889 /** 890 * A type of SourceCodeType that specifies a source branch name and a destination branch name in an associated repository. 891 */ 892 BranchDiff?: BranchDiffSourceCodeType; 893 /** 894 * Information about an associated repository in an S3 bucket that includes its name and an S3RepositoryDetails object. The S3RepositoryDetails object includes the name of an S3 bucket, an S3 key for a source code .zip file, and an S3 key for a build artifacts .zip file. S3BucketRepository is required in SourceCodeType for S3BucketRepository based code reviews. 895 */ 896 S3BucketRepository?: S3BucketRepository; 897 /** 898 * Metadata that is associated with a code review. This applies to any type of code review supported by CodeGuru Reviewer. The RequestMetadaa field captures any event metadata. For example, it might capture metadata associated with an event trigger, such as a push or a pull request. 899 */ 900 RequestMetadata?: RequestMetadata; 901 } 902 export type StateReason = string; 903 export type TagKey = string; 904 export type TagKeyList = TagKey[]; 905 export type TagMap = {[key: string]: TagValue}; 906 export interface TagResourceRequest { 907 /** 908 * The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations . 909 */ 910 resourceArn: AssociationArn; 911 /** 912 * An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive. An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive. 913 */ 914 Tags: TagMap; 915 } 916 export interface TagResourceResponse { 917 } 918 export type TagValue = string; 919 export type Text = string; 920 export interface ThirdPartySourceRepository { 921 /** 922 * The name of the third party source repository. 923 */ 924 Name: Name; 925 /** 926 * The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the AWS CodeStar Connections API Reference. 927 */ 928 ConnectionArn: ConnectionArn; 929 /** 930 * The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, this can be the username or AWS account ID. 931 */ 932 Owner: Owner; 933 } 934 export type TimeStamp = Date; 935 export type Type = "PullRequest"|"RepositoryAnalysis"|string; 936 export interface UntagResourceRequest { 937 /** 938 * The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations . 939 */ 940 resourceArn: AssociationArn; 941 /** 942 * A list of the keys for each tag you want to remove from an associated repository. 943 */ 944 TagKeys: TagKeyList; 945 } 946 export interface UntagResourceResponse { 947 } 948 export type UserId = string; 949 export type UserIds = UserId[]; 950 export type VendorName = "GitHub"|"GitLab"|"NativeS3"|string; 951 /** 952 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 953 */ 954 export type apiVersion = "2019-09-19"|"latest"|string; 955 export interface ClientApiVersions { 956 /** 957 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 958 */ 959 apiVersion?: apiVersion; 960 } 961 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 962 /** 963 * Contains interfaces for use with the CodeGuruReviewer client. 964 */ 965 export import Types = CodeGuruReviewer; 966 } 967 export = CodeGuruReviewer;