Type definitions#
Index > CodeGuruReviewer > Type definitions
Auto-generated documentation for CodeGuruReviewer type annotations stubs module mypy-boto3-codeguru-reviewer.
KMSKeyDetailsTypeDef#
# KMSKeyDetailsTypeDef definition
class KMSKeyDetailsTypeDef(TypedDict):
KMSKeyId: NotRequired[str],
EncryptionOption: NotRequired[EncryptionOptionType], # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BranchDiffSourceCodeTypeTypeDef#
# BranchDiffSourceCodeTypeTypeDef definition
class BranchDiffSourceCodeTypeTypeDef(TypedDict):
SourceBranchName: str,
DestinationBranchName: str,
CodeArtifactsTypeDef#
# CodeArtifactsTypeDef definition
class CodeArtifactsTypeDef(TypedDict):
SourceCodeArtifactsObjectKey: str,
BuildArtifactsObjectKey: NotRequired[str],
CodeCommitRepositoryTypeDef#
# CodeCommitRepositoryTypeDef definition
class CodeCommitRepositoryTypeDef(TypedDict):
Name: str,
MetricsSummaryTypeDef#
# MetricsSummaryTypeDef definition
class MetricsSummaryTypeDef(TypedDict):
MeteredLinesOfCodeCount: NotRequired[int],
SuppressedLinesOfCodeCount: NotRequired[int],
FindingsCount: NotRequired[int],
MetricsTypeDef#
# MetricsTypeDef definition
class MetricsTypeDef(TypedDict):
MeteredLinesOfCodeCount: NotRequired[int],
SuppressedLinesOfCodeCount: NotRequired[int],
FindingsCount: NotRequired[int],
CommitDiffSourceCodeTypeTypeDef#
# CommitDiffSourceCodeTypeTypeDef definition
class CommitDiffSourceCodeTypeTypeDef(TypedDict):
SourceCommit: NotRequired[str],
DestinationCommit: NotRequired[str],
MergeBaseCommit: NotRequired[str],
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeCodeReviewRequestRequestTypeDef#
# DescribeCodeReviewRequestRequestTypeDef definition
class DescribeCodeReviewRequestRequestTypeDef(TypedDict):
CodeReviewArn: str,
DescribeRecommendationFeedbackRequestRequestTypeDef#
# DescribeRecommendationFeedbackRequestRequestTypeDef definition
class DescribeRecommendationFeedbackRequestRequestTypeDef(TypedDict):
CodeReviewArn: str,
RecommendationId: str,
UserId: NotRequired[str],
RecommendationFeedbackTypeDef#
# RecommendationFeedbackTypeDef definition
class RecommendationFeedbackTypeDef(TypedDict):
CodeReviewArn: NotRequired[str],
RecommendationId: NotRequired[str],
Reactions: NotRequired[List[ReactionType]], # (1)
UserId: NotRequired[str],
CreatedTimeStamp: NotRequired[datetime],
LastUpdatedTimeStamp: NotRequired[datetime],
- See ReactionType
DescribeRepositoryAssociationRequestRequestTypeDef#
# DescribeRepositoryAssociationRequestRequestTypeDef definition
class DescribeRepositoryAssociationRequestRequestTypeDef(TypedDict):
AssociationArn: str,
DisassociateRepositoryRequestRequestTypeDef#
# DisassociateRepositoryRequestRequestTypeDef definition
class DisassociateRepositoryRequestRequestTypeDef(TypedDict):
AssociationArn: str,
EventInfoTypeDef#
# EventInfoTypeDef definition
class EventInfoTypeDef(TypedDict):
Name: NotRequired[str],
State: NotRequired[str],
ListCodeReviewsRequestRequestTypeDef#
# ListCodeReviewsRequestRequestTypeDef definition
class ListCodeReviewsRequestRequestTypeDef(TypedDict):
Type: TypeType, # (1)
ProviderTypes: NotRequired[Sequence[ProviderTypeType]], # (2)
States: NotRequired[Sequence[JobStateType]], # (3)
RepositoryNames: NotRequired[Sequence[str]],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See TypeType
- See ProviderTypeType
- See JobStateType
ListRecommendationFeedbackRequestRequestTypeDef#
# ListRecommendationFeedbackRequestRequestTypeDef definition
class ListRecommendationFeedbackRequestRequestTypeDef(TypedDict):
CodeReviewArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
UserIds: NotRequired[Sequence[str]],
RecommendationIds: NotRequired[Sequence[str]],
RecommendationFeedbackSummaryTypeDef#
# RecommendationFeedbackSummaryTypeDef definition
class RecommendationFeedbackSummaryTypeDef(TypedDict):
RecommendationId: NotRequired[str],
Reactions: NotRequired[List[ReactionType]], # (1)
UserId: NotRequired[str],
- See ReactionType
ListRecommendationsRequestRequestTypeDef#
# ListRecommendationsRequestRequestTypeDef definition
class ListRecommendationsRequestRequestTypeDef(TypedDict):
CodeReviewArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListRepositoryAssociationsRequestRequestTypeDef#
# ListRepositoryAssociationsRequestRequestTypeDef definition
class ListRepositoryAssociationsRequestRequestTypeDef(TypedDict):
ProviderTypes: NotRequired[Sequence[ProviderTypeType]], # (1)
States: NotRequired[Sequence[RepositoryAssociationStateType]], # (2)
Names: NotRequired[Sequence[str]],
Owners: NotRequired[Sequence[str]],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
RepositoryAssociationSummaryTypeDef#
# RepositoryAssociationSummaryTypeDef definition
class RepositoryAssociationSummaryTypeDef(TypedDict):
AssociationArn: NotRequired[str],
ConnectionArn: NotRequired[str],
LastUpdatedTimeStamp: NotRequired[datetime],
AssociationId: NotRequired[str],
Name: NotRequired[str],
Owner: NotRequired[str],
ProviderType: NotRequired[ProviderTypeType], # (1)
State: NotRequired[RepositoryAssociationStateType], # (2)
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
PutRecommendationFeedbackRequestRequestTypeDef#
# PutRecommendationFeedbackRequestRequestTypeDef definition
class PutRecommendationFeedbackRequestRequestTypeDef(TypedDict):
CodeReviewArn: str,
RecommendationId: str,
Reactions: Sequence[ReactionType], # (1)
- See ReactionType
RuleMetadataTypeDef#
# RuleMetadataTypeDef definition
class RuleMetadataTypeDef(TypedDict):
RuleId: NotRequired[str],
RuleName: NotRequired[str],
ShortDescription: NotRequired[str],
LongDescription: NotRequired[str],
RuleTags: NotRequired[List[str]],
RepositoryHeadSourceCodeTypeTypeDef#
# RepositoryHeadSourceCodeTypeTypeDef definition
class RepositoryHeadSourceCodeTypeTypeDef(TypedDict):
BranchName: str,
S3RepositoryTypeDef#
# S3RepositoryTypeDef definition
class S3RepositoryTypeDef(TypedDict):
Name: str,
BucketName: str,
ThirdPartySourceRepositoryTypeDef#
# ThirdPartySourceRepositoryTypeDef definition
class ThirdPartySourceRepositoryTypeDef(TypedDict):
Name: str,
ConnectionArn: str,
Owner: str,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
TagKeys: Sequence[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
S3RepositoryDetailsTypeDef#
# S3RepositoryDetailsTypeDef definition
class S3RepositoryDetailsTypeDef(TypedDict):
BucketName: NotRequired[str],
CodeArtifacts: NotRequired[CodeArtifactsTypeDef], # (1)
DescribeCodeReviewRequestCodeReviewCompletedWaitTypeDef#
# DescribeCodeReviewRequestCodeReviewCompletedWaitTypeDef definition
class DescribeCodeReviewRequestCodeReviewCompletedWaitTypeDef(TypedDict):
CodeReviewArn: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeRepositoryAssociationRequestRepositoryAssociationSucceededWaitTypeDef#
# DescribeRepositoryAssociationRequestRepositoryAssociationSucceededWaitTypeDef definition
class DescribeRepositoryAssociationRequestRepositoryAssociationSucceededWaitTypeDef(TypedDict):
AssociationArn: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeRecommendationFeedbackResponseTypeDef#
# DescribeRecommendationFeedbackResponseTypeDef definition
class DescribeRecommendationFeedbackResponseTypeDef(TypedDict):
RecommendationFeedback: RecommendationFeedbackTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RequestMetadataTypeDef#
# RequestMetadataTypeDef definition
class RequestMetadataTypeDef(TypedDict):
RequestId: NotRequired[str],
Requester: NotRequired[str],
EventInfo: NotRequired[EventInfoTypeDef], # (1)
VendorName: NotRequired[VendorNameType], # (2)
- See EventInfoTypeDef
- See VendorNameType
ListRecommendationFeedbackResponseTypeDef#
# ListRecommendationFeedbackResponseTypeDef definition
class ListRecommendationFeedbackResponseTypeDef(TypedDict):
RecommendationFeedbackSummaries: List[RecommendationFeedbackSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRepositoryAssociationsRequestListRepositoryAssociationsPaginateTypeDef#
# ListRepositoryAssociationsRequestListRepositoryAssociationsPaginateTypeDef definition
class ListRepositoryAssociationsRequestListRepositoryAssociationsPaginateTypeDef(TypedDict):
ProviderTypes: NotRequired[Sequence[ProviderTypeType]], # (1)
States: NotRequired[Sequence[RepositoryAssociationStateType]], # (2)
Names: NotRequired[Sequence[str]],
Owners: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListRepositoryAssociationsResponseTypeDef#
# ListRepositoryAssociationsResponseTypeDef definition
class ListRepositoryAssociationsResponseTypeDef(TypedDict):
RepositoryAssociationSummaries: List[RepositoryAssociationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RecommendationSummaryTypeDef#
# RecommendationSummaryTypeDef definition
class RecommendationSummaryTypeDef(TypedDict):
FilePath: NotRequired[str],
RecommendationId: NotRequired[str],
StartLine: NotRequired[int],
EndLine: NotRequired[int],
Description: NotRequired[str],
RecommendationCategory: NotRequired[RecommendationCategoryType], # (1)
RuleMetadata: NotRequired[RuleMetadataTypeDef], # (2)
Severity: NotRequired[SeverityType], # (3)
RepositoryTypeDef#
# RepositoryTypeDef definition
class RepositoryTypeDef(TypedDict):
CodeCommit: NotRequired[CodeCommitRepositoryTypeDef], # (1)
Bitbucket: NotRequired[ThirdPartySourceRepositoryTypeDef], # (2)
GitHubEnterpriseServer: NotRequired[ThirdPartySourceRepositoryTypeDef], # (2)
S3Bucket: NotRequired[S3RepositoryTypeDef], # (4)
- See CodeCommitRepositoryTypeDef
- See ThirdPartySourceRepositoryTypeDef
- See ThirdPartySourceRepositoryTypeDef
- See S3RepositoryTypeDef
RepositoryAssociationTypeDef#
# RepositoryAssociationTypeDef definition
class RepositoryAssociationTypeDef(TypedDict):
AssociationId: NotRequired[str],
AssociationArn: NotRequired[str],
ConnectionArn: NotRequired[str],
Name: NotRequired[str],
Owner: NotRequired[str],
ProviderType: NotRequired[ProviderTypeType], # (1)
State: NotRequired[RepositoryAssociationStateType], # (2)
StateReason: NotRequired[str],
LastUpdatedTimeStamp: NotRequired[datetime],
CreatedTimeStamp: NotRequired[datetime],
KMSKeyDetails: NotRequired[KMSKeyDetailsTypeDef], # (3)
S3RepositoryDetails: NotRequired[S3RepositoryDetailsTypeDef], # (4)
- See ProviderTypeType
- See RepositoryAssociationStateType
- See KMSKeyDetailsTypeDef
- See S3RepositoryDetailsTypeDef
S3BucketRepositoryTypeDef#
# S3BucketRepositoryTypeDef definition
class S3BucketRepositoryTypeDef(TypedDict):
Name: str,
Details: NotRequired[S3RepositoryDetailsTypeDef], # (1)
ListRecommendationsResponseTypeDef#
# ListRecommendationsResponseTypeDef definition
class ListRecommendationsResponseTypeDef(TypedDict):
RecommendationSummaries: List[RecommendationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssociateRepositoryRequestRequestTypeDef#
# AssociateRepositoryRequestRequestTypeDef definition
class AssociateRepositoryRequestRequestTypeDef(TypedDict):
Repository: RepositoryTypeDef, # (1)
ClientRequestToken: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
KMSKeyDetails: NotRequired[KMSKeyDetailsTypeDef], # (2)
AssociateRepositoryResponseTypeDef#
# AssociateRepositoryResponseTypeDef definition
class AssociateRepositoryResponseTypeDef(TypedDict):
RepositoryAssociation: RepositoryAssociationTypeDef, # (1)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeRepositoryAssociationResponseTypeDef#
# DescribeRepositoryAssociationResponseTypeDef definition
class DescribeRepositoryAssociationResponseTypeDef(TypedDict):
RepositoryAssociation: RepositoryAssociationTypeDef, # (1)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DisassociateRepositoryResponseTypeDef#
# DisassociateRepositoryResponseTypeDef definition
class DisassociateRepositoryResponseTypeDef(TypedDict):
RepositoryAssociation: RepositoryAssociationTypeDef, # (1)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SourceCodeTypeTypeDef#
# SourceCodeTypeTypeDef definition
class SourceCodeTypeTypeDef(TypedDict):
CommitDiff: NotRequired[CommitDiffSourceCodeTypeTypeDef], # (1)
RepositoryHead: NotRequired[RepositoryHeadSourceCodeTypeTypeDef], # (2)
BranchDiff: NotRequired[BranchDiffSourceCodeTypeTypeDef], # (3)
S3BucketRepository: NotRequired[S3BucketRepositoryTypeDef], # (4)
RequestMetadata: NotRequired[RequestMetadataTypeDef], # (5)
- See CommitDiffSourceCodeTypeTypeDef
- See RepositoryHeadSourceCodeTypeTypeDef
- See BranchDiffSourceCodeTypeTypeDef
- See S3BucketRepositoryTypeDef
- See RequestMetadataTypeDef
CodeReviewSummaryTypeDef#
# CodeReviewSummaryTypeDef definition
class CodeReviewSummaryTypeDef(TypedDict):
Name: NotRequired[str],
CodeReviewArn: NotRequired[str],
RepositoryName: NotRequired[str],
Owner: NotRequired[str],
ProviderType: NotRequired[ProviderTypeType], # (1)
State: NotRequired[JobStateType], # (2)
CreatedTimeStamp: NotRequired[datetime],
LastUpdatedTimeStamp: NotRequired[datetime],
Type: NotRequired[TypeType], # (3)
PullRequestId: NotRequired[str],
MetricsSummary: NotRequired[MetricsSummaryTypeDef], # (4)
SourceCodeType: NotRequired[SourceCodeTypeTypeDef], # (5)
- See ProviderTypeType
- See JobStateType
- See TypeType
- See MetricsSummaryTypeDef
- See SourceCodeTypeTypeDef
CodeReviewTypeDef#
# CodeReviewTypeDef definition
class CodeReviewTypeDef(TypedDict):
Name: NotRequired[str],
CodeReviewArn: NotRequired[str],
RepositoryName: NotRequired[str],
Owner: NotRequired[str],
ProviderType: NotRequired[ProviderTypeType], # (1)
State: NotRequired[JobStateType], # (2)
StateReason: NotRequired[str],
CreatedTimeStamp: NotRequired[datetime],
LastUpdatedTimeStamp: NotRequired[datetime],
Type: NotRequired[TypeType], # (3)
PullRequestId: NotRequired[str],
SourceCodeType: NotRequired[SourceCodeTypeTypeDef], # (4)
AssociationArn: NotRequired[str],
Metrics: NotRequired[MetricsTypeDef], # (5)
AnalysisTypes: NotRequired[List[AnalysisTypeType]], # (6)
ConfigFileState: NotRequired[ConfigFileStateType], # (7)
- See ProviderTypeType
- See JobStateType
- See TypeType
- See SourceCodeTypeTypeDef
- See MetricsTypeDef
- See AnalysisTypeType
- See ConfigFileStateType
RepositoryAnalysisTypeDef#
# RepositoryAnalysisTypeDef definition
class RepositoryAnalysisTypeDef(TypedDict):
RepositoryHead: NotRequired[RepositoryHeadSourceCodeTypeTypeDef], # (1)
SourceCodeType: NotRequired[SourceCodeTypeTypeDef], # (2)
ListCodeReviewsResponseTypeDef#
# ListCodeReviewsResponseTypeDef definition
class ListCodeReviewsResponseTypeDef(TypedDict):
CodeReviewSummaries: List[CodeReviewSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateCodeReviewResponseTypeDef#
# CreateCodeReviewResponseTypeDef definition
class CreateCodeReviewResponseTypeDef(TypedDict):
CodeReview: CodeReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCodeReviewResponseTypeDef#
# DescribeCodeReviewResponseTypeDef definition
class DescribeCodeReviewResponseTypeDef(TypedDict):
CodeReview: CodeReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CodeReviewTypeTypeDef#
# CodeReviewTypeTypeDef definition
class CodeReviewTypeTypeDef(TypedDict):
RepositoryAnalysis: RepositoryAnalysisTypeDef, # (1)
AnalysisTypes: NotRequired[Sequence[AnalysisTypeType]], # (2)
CreateCodeReviewRequestRequestTypeDef#
# CreateCodeReviewRequestRequestTypeDef definition
class CreateCodeReviewRequestRequestTypeDef(TypedDict):
Name: str,
RepositoryAssociationArn: str,
Type: CodeReviewTypeTypeDef, # (1)
ClientRequestToken: NotRequired[str],