Beispiele für die Verwendung der AWS CLI mit CodeGuru Reviewer - AWS Command Line Interface
Aktionen

Beispiele für die Verwendung der AWS CLI mit CodeGuru Reviewer

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit CodeGuru Reviewer nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie associate-repository verwendet wird.

AWS CLI

Beispiel 1: So erstellen Sie eine Bitbucket-Repository-Zuordnung

Im folgenden associate-repository-Beispiel wird eine Repository-Zuordnung mithilfe eines vorhandenen Bitbucket-Repositorys erstellt.

aws codeguru-reviewer associate-repository \
    --repository 'Bitbucket={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'

Ausgabe:

{
    "RepositoryAssociation": {
        "ProviderType": "Bitbucket",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596216896.979,
        "AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "State": "Associating",
        "StateReason": "Pending Repository Association",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "Owner": "sample-owner"
    }
}

Weitere Informationen finden Sie unter Create a Bitbucket repository association in Amazon CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Beispiel 2: So erstellen Sie eine Zuordnung für ein GitHub-Enterprise-Repository

Im folgenden associate-repository-Beispiel wird eine Repository-Zuordnung mithilfe eines vorhandenen GitHub-Enterprise-Repositorys erstellt.

aws codeguru-reviewer associate-repository \
    --repository 'GitHubEnterpriseServer={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'

Ausgabe:

{
    "RepositoryAssociation": {
        "ProviderType": "GitHubEnterpriseServer",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596216896.979,
        "AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "State": "Associating",
        "StateReason": "Pending Repository Association",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "Owner": "sample-owner"
    }
}

Weitere Informationen finden Sie unter Erstellen einer Repository-Zuordnung für GitHub Enterprise Server in Amazon CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Beispiel 3: So erstellen Sie eine Zuordnung zu einem AWS-CodeCommit-Repository

Im folgenden associate-repository-Beispiel wird eine Repository-Zuordnung mithilfe eines vorhandenen AWS-CodeCommit-Repositorys erstellt.

aws codeguru-reviewer associate-repository \
    --repository CodeCommit={Name=mySampleRepo}

Ausgabe:

{
    "RepositoryAssociation": {
        "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "Name": "My-ecs-beta-repo",
        "LastUpdatedTimeStamp": 1595634764.029,
        "ProviderType": "CodeCommit",
        "CreatedTimeStamp": 1595634764.029,
        "Owner": "544120495673",
        "State": "Associating",
        "StateReason": "Pending Repository Association",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:544120495673:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
    }
}

Weitere Informationen finden Sie unter Erstellen einer Zuordnung zu einem AWS-CodeCommit-Repository im Amazon CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie create-code-review verwendet wird.

AWS CLI

So erstellen eine Codeüberprüfung

Mit dem folgenden create-code-review-Befehl wird eine Überprüfung des Codes im mainline-Branch eines AWS-CodeCommit-Repositorys mit dem Namen my-repository-name erstellt.

aws codeguru-reviewer create-code-review \
    --name my-code-review \
    --repository-association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --type '{"RepositoryAnalysis": {"RepositoryHead": {"BranchName": "mainline"}}}'

Ausgabe:

{
    "CodeReview": {
        "Name": "my-code-review",
        "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222:code-review:RepositoryAnalysis-my-code-review",
        "RepositoryName": "my-repository-name",
        "Owner": "123456789012",
        "ProviderType": "CodeCommit",
        "State": "Pending",
        "StateReason": "CodeGuru Reviewer has received the request, and a code review is scheduled.",
        "CreatedTimeStamp": 1618873489.195,
        "LastUpdatedTimeStamp": 1618873489.195,
        "Type": "RepositoryAnalysis",
        "SourceCodeType": {
            "RepositoryHead": {
                "BranchName": "mainline"
            }
        },
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
    }
}

Weitere Informationen finden Sie unter Erstellen von Codeüberprüfungen in Amazon CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

  • API-Details finden Sie unter CreateCodeReview in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-code-review verwendet wird.

AWS CLI

Auflisten von Details zu einer Codeüberprüfung

Mit dem folgenden describe-code-review-Befehl werden Informationen zur Überprüfung von Code im Branch „mainline“ eines AWS-CodeCommit-Repositorys mit dem Namen „my-repo-name“ aufgeführt.

aws codeguru-reviewer put-recommendation-feedback \
    --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \
    --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb \
    --reactions ThumbsUp

Output

{
        "CodeReview": {
            "Name": "My-ecs-beta-repo-master-xs6di4kfd4j269dz",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222:code-review:RepositoryAnalysis-my-repo-name",
            "RepositoryName": "My-ecs-beta-repo",
            "Owner": "123456789012",
            "ProviderType": "CodeCommit",
            "State": "Pending",
            "StateReason": "CodeGuru Reviewer is reviewing the source code.",
            "CreatedTimeStamp": 1618874226.226,
            "LastUpdatedTimeStamp": 1618874233.689,
            "Type": "RepositoryAnalysis",
            "SourceCodeType": {
                "RepositoryHead": {
                    "BranchName": "mainline"
                }
            },
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
        }
    }

Weitere Informationen finden Sie unter View code review details im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie describe-recommendation-feedback verwendet wird.

AWS CLI

So zeigen Sie Informationen zu Feedback für eine Empfehlung an

Mit dem folgenden describe-recommendation-feedback-Befehl werden Informationen zu Feedback für eine Empfehlung angezeigt. Diese Empfehlung hat eine ThumbsUp-Reaktion.

aws codeguru-reviewer describe-recommendation-feedback \
    --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \
    --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb

Ausgabe:

{
    "RecommendationFeedback": {
        "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678",
        "RecommendationId": "3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb",
        "Reactions": [
            "ThumbsUp"
        ],
        "UserId": "aws-user-id",
        "CreatedTimeStamp": 1618877070.313,
        "LastUpdatedTimeStamp": 1618877948.881
    }
}

Weitere Informationen finden Sie unter Anzeigen von Empfehlungen und Bereitstellen von Feedback und Schritt 4: Bereitstellen von Feedback im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie describe-repository-association verwendet wird.

AWS CLI

Beispiel 1: So geben Sie Informationen zu einer GitHub-Repository-Zuordnung zurück

Das folgende describe-repository-association-Beispiel gibt Informationen zu einer Repository-Zuordnung zurück, die ein GitHub-Enterprise-Repository verwendet und sich im Status Associated befindet.

aws codeguru-reviewer describe-repository-association \
    --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Ausgabe:

{
    "RepositoryAssociation": {
        "AssociationId": "b822717e-0711-4e8a-bada-0e738289c75e",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1588102637.649,
        "ProviderType": "GitHub",
        "CreatedTimeStamp": 1588102615.636,
        "Owner": "sample-owner",
        "State": "Associated",
        "StateReason": "Pull Request Notification configuration successful",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
    }
}

Weitere Informationen finden Sie unter Erstellen einer Repository-Zuordnung für GitHub Enterprise Server in Amazon CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Beispiel 2: So geben Sie Informationen zu einer fehlgeschlagenen Repository-Zuordnung zurück

Das folgende describe-repository-association-Beispiel gibt Informationen zu einer Repository-Zuordnung zurück, die ein GitHub-Enterprise-Repository verwendet und sich im Status Failed befindet.

aws codeguru-reviewer describe-repository-association \
    --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Ausgabe:

{
    "RepositoryAssociation": {
        "ProviderType": "GitHubEnterpriseServer",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596217036.892,
        "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "State": "Failed",
        "StateReason": "Failed, Please retry.",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
        "Owner": "sample-owner"
    }
}

Weitere Informationen finden Sie unter Erstellen einer Repository-Zuordnung für GitHub Enterprise Server in Amazon CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Beispiel 3: So geben Sie Informationen zu einer Repository-Zuordnung zurück, die getrennt wird

Das folgende describe-repository-association-Beispiel gibt Informationen zu einer Repository-Zuordnung zurück, die ein GitHub-Enterprise-Repository verwendet und sich im Status Disassociating befindet.

aws codeguru-reviewer describe-repository-association \
    --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Ausgabe:

{
    "RepositoryAssociation": {
        "ProviderType": "GitHubEnterpriseServer",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596217036.892,
        "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "State": "Disassociating",
        "StateReason": "Source code access removal in progress",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
        "Owner": "sample-owner"
    }
}

Weitere Informationen finden Sie unter Erstellen einer Repository-Zuordnung für GitHub Enterprise Server in Amazon CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie disassociate-repository verwendet wird.

AWS CLI

So heben Sie die Zuordnung einer Repository-Verknüpfung auf

Im folgenden disassociate-repository-Beispiel wird eine Repository-Zuordnung aufgehoben, die ein AWS-CodeCommit-Repository verwendet.

aws codeguru-reviewer disassociate-repository \
    --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Ausgabe:

{
    "RepositoryAssociation": {
        "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "Name": "my-repository",
        "Owner": "123456789012",
        "ProviderType": "CodeCommit",
        "State": "Disassociating",
        "LastUpdatedTimeStamp": 1618939174.759,
        "CreatedTimeStamp": 1595636947.096
    },
    "Tags": {
        "Status": "Secret",
        "Team": "Saanvi"
    }
}

Weitere Informationen finden Sie unter Disassociate a repository in CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie list-code-reviews verwendet wird.

AWS CLI

So listen Sie Codeüberprüfungen auf, die in den letzten 90 Tagen in Ihrem AWS-Konto erstellt wurden

Das folgende list-code-reviews-Beispiel listet die in den letzten 90 Tagen erstellten Codeüberprüfungen mithilfe von Pull-Anforderungen auf.

aws codeguru-reviewer list-code-reviews \
    --type PullRequest

Ausgabe:

{
    "CodeReviewSummaries": [
        {
            "LastUpdatedTimeStamp": 1588897288.054,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ProviderType": "GitHub",
            "PullRequestId": "5",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 24,
                "FindingsCount": 1
            },
            "CreatedTimeStamp": 1588897068.512,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588869793.263,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "ProviderType": "GitHub",
            "PullRequestId": "4",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 29,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588869575.949,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588870511.211,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ProviderType": "GitHub",
            "PullRequestId": "4",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 2,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588870292.425,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588118522.452,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "ProviderType": "GitHub",
            "PullRequestId": "3",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 29,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588118301.131,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588112205.207,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "ProviderType": "GitHub",
            "PullRequestId": "2",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 25,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588111987.443,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588104489.981,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "ProviderType": "GitHub",
            "PullRequestId": "1",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 25,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588104270.223,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        }
    ]
}

Weitere Informationen finden Sie unter View all code reviews im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

  • API-Details finden Sie unter ListCodeReviews in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-recommendation-feedback verwendet wird.

AWS CLI

So listen Sie Kundenfeedback für eine Empfehlung in einem zugehörigen Repository auf

Mit dem folgenden list-recommendation-feedback-Befehl wird Kundenfeedback zu allen Empfehlungen im Rahmen einer Codeüberprüfung aufgelistet. Diese Codeüberprüfung enthält ein Feedback („ThumbsUp“) von einem Kunden.

aws codeguru-reviewer list-recommendation-feedback \
    --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678

Ausgabe:

{
    "RecommendationFeedbackSummaries": [
        {
            "RecommendationId": "3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb",
            "Reactions": [
                "ThumbsUp"
            ],
            "UserId": "aws-user-id"
        }
    ]
}

Weitere Informationen finden Sie unter Schritt 4: Bereitstellen von Feedback im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie list-recommendations verwendet wird.

AWS CLI

So listen Sie die Empfehlungen für eine abgeschlossene Codeüberprüfung auf

Im folgenden list-recommendations-Beispiel werden die Empfehlungen für eine abgeschlossene Codeüberprüfung aufgeführt. Diese Codeüberprüfung enthält eine Empfehlung.

aws codeguru-reviewer list-recommendations \
    --code-review-arn arn:aws:codeguru-reviewer:us-west-2:544120495673:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Ausgabe:

{
    "RecommendationSummaries": [
        {
            "Description": "\n\n**Problem**  \n You are using a `ConcurrentHashMap`, but your usage of `containsKey()` and `get()` may not be thread-safe at lines: **63 and 64**. In between the check and the `get()` another thread can remove the key and the `get()` will return `null`. The remove that can remove the key is at line: **59**.\n\n**Fix**  \n Consider calling `get()`, checking instead of your current check if the returned object is `null`, and then using that object only, without calling `get()` again.\n\n**More info**  \n [View an example on GitHub](https://github.com/apache/hadoop/blob/f16cf877e565084c66bc63605659b157c4394dc8/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3Guard.java#L302-L304) (external link).",
            "RecommendationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "StartLine": 63,
            "EndLine": 64,
            "FilePath": "src/main/java/com/company/sample/application/CreateOrderThread.java"
        }
    ]
}

Weitere Informationen finden Sie unter Schritt 4: Bereitstellen von Feedback im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie list-repository-associations verwendet wird.

AWS CLI

So listen Sie die Repository-Zuordnungen in Ihrem AWS-Konto auf

Das folgende list-repository-associations-Beispiel gibt eine Liste von Zusammenfassungsobjekten für Repository-Zuordnungen in Ihrem Konto zurück. Sie können die zurückgegebene Liste nach ProviderType, Name, State und Owner filtern.

aws codeguru-reviewer list-repository-associations

Ausgabe:

{
    "RepositoryAssociationSummaries": [
        {
            "LastUpdatedTimeStamp": 1595886609.616,
            "Name": "test",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Owner": "sample-owner",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ProviderType": "Bitbucket"
        },
        {
            "LastUpdatedTimeStamp": 1595636969.035,
            "Name": "CodeDeploy-CodePipeline-ECS-Tutorial",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "Owner": "123456789012",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "ProviderType": "CodeCommit"
        },
        {
            "LastUpdatedTimeStamp": 1595634785.983,
            "Name": "My-ecs-beta-repo",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "Owner": "123456789012",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ProviderType": "CodeCommit"
        },
        {
            "LastUpdatedTimeStamp": 1590712811.77,
            "Name": "MyTestCodeCommit",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "Owner": "123456789012",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "ProviderType": "CodeCommit"
        },
        {
            "LastUpdatedTimeStamp": 1588102637.649,
            "Name": "aws-codeguru-profiler-sample-application",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "Owner": "sample-owner",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "ProviderType": "GitHub"
        },
        {
            "LastUpdatedTimeStamp": 1588028233.995,
            "Name": "codeguru-profiler-demo-app",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "Owner": "sample-owner",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "ProviderType": "GitHub"
        }
    ]
}

Weitere Informationen finden Sie unter View all repository associations in CodeGuru Reviewer im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So listen Sie die Tags für ein zugeordnetes Repository auf

Der folgende list-tags-for-resource-Befehl listet die Tags für ein zugeordnetes Repository auf. Dieses zugehörige Repository hat zwei Tags.

aws codeguru-reviewer list-tags-for-resource \
    --resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Ausgabe:

{
    "Tags": {
        "Status": "Secret",
        "Team": "Saanvi"
    }
}

Weitere Informationen finden Sie unter View tags for a CodeGuru Reviewer associated repository (AWS CLI) im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie put-recommendation-feedback verwendet wird.

AWS CLI

So fügen Sie eine Empfehlung zu einer Codeüberprüfung hinzu

Mit dem folgenden put-recommendation-feedback-Befehl wird einer Codeüberprüfung eine ThumbsUp-Empfehlung hinzugefügt.

aws codeguru-reviewer put-recommendation-feedback \
    --code-review-arn \arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \
    --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb \
    --reactions ThumbsUp

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Schritt 4: Bereitstellen von Feedback im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So fügen Sie ein Tag zu einem zugeordneten Repository hinzu

Der folgende tag-resource-Befehl fügt einem zugeordneten Repository zwei Tags hinzu.

aws codeguru-reviewer tag-resource \
    --resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --tags Status=Secret,Team=Saanvi

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Hinzufügen eines Tags zu einem CodeGuru Reviewer zugeordneten Repository (AWS CLI) und Hinzufügen oder Aktualisieren von Tags für ein CodeGuru Reviewer zugeordnetes Repository (AWS CLI) im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie Tags aus einem zugeordneten Repository

Mit dem folgenden untag-resource-Befehl werden zwei Tags mit den Schlüsseln „Secret“ und „Team“ aus einem zugehörigen Repository entfernt.

aws codeguru-reviewer untag-resource \
    --resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --tag-keys Status Team

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Remove tags from a CodeGuru Reviewer associated repository (AWS CLI) im Benutzerhandbuch zu Amazon CodeGuru Reviewer.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.