CodeGuruReviewerClient

Index > CodeGuruReviewer > CodeGuruReviewerClient

Auto-generated documentation for CodeGuruReviewer type annotations stubs module mypy-boto3-codeguru-reviewer.

CodeGuruReviewerClient

Type annotations and code completion for boto3.client("codeguru-reviewer"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_codeguru_reviewer.client import CodeGuruReviewerClient

def get_codeguru-reviewer_client() -> CodeGuruReviewerClient:
    return Session().client("codeguru-reviewer")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("codeguru-reviewer").exceptions structure.

Usage example

client = boto3.client("codeguru-reviewer")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.NotFoundException,
    client.ResourceNotFoundException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_codeguru_reviewer.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

associate_repository

Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer.

Type annotations and code completion for boto3.client("codeguru-reviewer").associate_repository method. boto3 documentation

Method definition

def associate_repository(
    self,
    *,
    Repository: RepositoryTypeDef,  # (1)
    ClientRequestToken: str = ...,
    Tags: Mapping[str, str] = ...,
    KMSKeyDetails: KMSKeyDetailsTypeDef = ...,  # (2)
) -> AssociateRepositoryResponseTypeDef:  # (3)
    ...

1. See RepositoryTypeDef
2. See KMSKeyDetailsTypeDef
3. See AssociateRepositoryResponseTypeDef

Usage example with kwargs

kwargs: AssociateRepositoryRequestRequestTypeDef = {  # (1)
    "Repository": ...,
}

parent.associate_repository(**kwargs)

1. See AssociateRepositoryRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("codeguru-reviewer").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("codeguru-reviewer").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_code_review

Use to create a code review with a CodeReviewType_ of RepositoryAnalysis.

Type annotations and code completion for boto3.client("codeguru-reviewer").create_code_review method. boto3 documentation

Method definition

def create_code_review(
    self,
    *,
    Name: str,
    RepositoryAssociationArn: str,
    Type: CodeReviewTypeTypeDef,  # (1)
    ClientRequestToken: str = ...,
) -> CreateCodeReviewResponseTypeDef:  # (2)
    ...

1. See CodeReviewTypeTypeDef
2. See CreateCodeReviewResponseTypeDef

Usage example with kwargs

kwargs: CreateCodeReviewRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RepositoryAssociationArn": ...,
    "Type": ...,
}

parent.create_code_review(**kwargs)

1. See CreateCodeReviewRequestRequestTypeDef

describe_code_review

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

Type annotations and code completion for boto3.client("codeguru-reviewer").describe_code_review method. boto3 documentation

Method definition

def describe_code_review(
    self,
    *,
    CodeReviewArn: str,
) -> DescribeCodeReviewResponseTypeDef:  # (1)
    ...

1. See DescribeCodeReviewResponseTypeDef

Usage example with kwargs

kwargs: DescribeCodeReviewRequestRequestTypeDef = {  # (1)
    "CodeReviewArn": ...,
}

parent.describe_code_review(**kwargs)

1. See DescribeCodeReviewRequestRequestTypeDef

describe_recommendation_feedback

Describes the customer feedback for a CodeGuru Reviewer recommendation.

Type annotations and code completion for boto3.client("codeguru-reviewer").describe_recommendation_feedback method. boto3 documentation

Method definition

def describe_recommendation_feedback(
    self,
    *,
    CodeReviewArn: str,
    RecommendationId: str,
    UserId: str = ...,
) -> DescribeRecommendationFeedbackResponseTypeDef:  # (1)
    ...

1. See DescribeRecommendationFeedbackResponseTypeDef

Usage example with kwargs

kwargs: DescribeRecommendationFeedbackRequestRequestTypeDef = {  # (1)
    "CodeReviewArn": ...,
    "RecommendationId": ...,
}

parent.describe_recommendation_feedback(**kwargs)

1. See DescribeRecommendationFeedbackRequestRequestTypeDef

describe_repository_association

Returns a RepositoryAssociation_ object that contains information about the requested repository association.

Type annotations and code completion for boto3.client("codeguru-reviewer").describe_repository_association method. boto3 documentation

Method definition

def describe_repository_association(
    self,
    *,
    AssociationArn: str,
) -> DescribeRepositoryAssociationResponseTypeDef:  # (1)
    ...

1. See DescribeRepositoryAssociationResponseTypeDef

Usage example with kwargs

kwargs: DescribeRepositoryAssociationRequestRequestTypeDef = {  # (1)
    "AssociationArn": ...,
}

parent.describe_repository_association(**kwargs)

1. See DescribeRepositoryAssociationRequestRequestTypeDef

disassociate_repository

Removes the association between Amazon CodeGuru Reviewer and a repository.

Type annotations and code completion for boto3.client("codeguru-reviewer").disassociate_repository method. boto3 documentation

Method definition

def disassociate_repository(
    self,
    *,
    AssociationArn: str,
) -> DisassociateRepositoryResponseTypeDef:  # (1)
    ...

1. See DisassociateRepositoryResponseTypeDef

Usage example with kwargs

kwargs: DisassociateRepositoryRequestRequestTypeDef = {  # (1)
    "AssociationArn": ...,
}

parent.disassociate_repository(**kwargs)

1. See DisassociateRepositoryRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("codeguru-reviewer").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_code_reviews

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

Type annotations and code completion for boto3.client("codeguru-reviewer").list_code_reviews method. boto3 documentation

Method definition

def list_code_reviews(
    self,
    *,
    Type: TypeType,  # (1)
    ProviderTypes: Sequence[ProviderTypeType] = ...,  # (2)
    States: Sequence[JobStateType] = ...,  # (3)
    RepositoryNames: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCodeReviewsResponseTypeDef:  # (4)
    ...

1. See TypeType
2. See ProviderTypeType
3. See JobStateType
4. See ListCodeReviewsResponseTypeDef

Usage example with kwargs

kwargs: ListCodeReviewsRequestRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.list_code_reviews(**kwargs)

1. See ListCodeReviewsRequestRequestTypeDef

list_recommendation_feedback

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

Type annotations and code completion for boto3.client("codeguru-reviewer").list_recommendation_feedback method. boto3 documentation

Method definition

def list_recommendation_feedback(
    self,
    *,
    CodeReviewArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    UserIds: Sequence[str] = ...,
    RecommendationIds: Sequence[str] = ...,
) -> ListRecommendationFeedbackResponseTypeDef:  # (1)
    ...

1. See ListRecommendationFeedbackResponseTypeDef

Usage example with kwargs

kwargs: ListRecommendationFeedbackRequestRequestTypeDef = {  # (1)
    "CodeReviewArn": ...,
}

parent.list_recommendation_feedback(**kwargs)

1. See ListRecommendationFeedbackRequestRequestTypeDef

list_recommendations

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

Type annotations and code completion for boto3.client("codeguru-reviewer").list_recommendations method. boto3 documentation

Method definition

def list_recommendations(
    self,
    *,
    CodeReviewArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRecommendationsResponseTypeDef:  # (1)
    ...

1. See ListRecommendationsResponseTypeDef

Usage example with kwargs

kwargs: ListRecommendationsRequestRequestTypeDef = {  # (1)
    "CodeReviewArn": ...,
}

parent.list_recommendations(**kwargs)

1. See ListRecommendationsRequestRequestTypeDef

list_repository_associations

Returns a list of RepositoryAssociationSummary_ objects that contain summary information about a repository association.

Type annotations and code completion for boto3.client("codeguru-reviewer").list_repository_associations method. boto3 documentation

Method definition

def list_repository_associations(
    self,
    *,
    ProviderTypes: Sequence[ProviderTypeType] = ...,  # (1)
    States: Sequence[RepositoryAssociationStateType] = ...,  # (2)
    Names: Sequence[str] = ...,
    Owners: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRepositoryAssociationsResponseTypeDef:  # (3)
    ...

1. See ProviderTypeType
2. See RepositoryAssociationStateType
3. See ListRepositoryAssociationsResponseTypeDef

Usage example with kwargs

kwargs: ListRepositoryAssociationsRequestRequestTypeDef = {  # (1)
    "ProviderTypes": ...,
}

parent.list_repository_associations(**kwargs)

1. See ListRepositoryAssociationsRequestRequestTypeDef

list_tags_for_resource

Returns the list of tags associated with an associated repository resource.

Type annotations and code completion for boto3.client("codeguru-reviewer").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_recommendation_feedback

Stores customer feedback for a CodeGuru Reviewer recommendation.

Type annotations and code completion for boto3.client("codeguru-reviewer").put_recommendation_feedback method. boto3 documentation

Method definition

def put_recommendation_feedback(
    self,
    *,
    CodeReviewArn: str,
    RecommendationId: str,
    Reactions: Sequence[ReactionType],  # (1)
) -> Dict[str, Any]:
    ...

1. See ReactionType

Usage example with kwargs

kwargs: PutRecommendationFeedbackRequestRequestTypeDef = {  # (1)
    "CodeReviewArn": ...,
    "RecommendationId": ...,
    "Reactions": ...,
}

parent.put_recommendation_feedback(**kwargs)

1. See PutRecommendationFeedbackRequestRequestTypeDef

tag_resource

Adds one or more tags to an associated repository.

Type annotations and code completion for boto3.client("codeguru-reviewer").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag from an associated repository.

Type annotations and code completion for boto3.client("codeguru-reviewer").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("codeguru-reviewer").get_paginator method with overloads.

• client.get_paginator("list_repository_associations") -> ListRepositoryAssociationsPaginator

get_waiter

Type annotations and code completion for boto3.client("codeguru-reviewer").get_waiter method with overloads.

• client.get_waiter("code_review_completed") -> CodeReviewCompletedWaiter
• client.get_waiter("repository_association_succeeded") -> RepositoryAssociationSucceededWaiter