This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java code.
By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.
", "operations": { - "AssociateRepository": "Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.
If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in the Amazon CodeGuru Reviewer User Guide.
You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.
Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.
If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in the Amazon CodeGuru Reviewer User Guide.
You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.
Use to create a code review for a repository analysis.
", "DescribeCodeReview": "Returns the metadata associated with the code review along with its status.
", "DescribeRecommendationFeedback": "Describes the customer feedback for a CodeGuru Reviewer recommendation.
", "DescribeRepositoryAssociation": " Returns a RepositoryAssociation object that contains information about the requested repository association.
The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories.
A code review can only be created on an associated repository. This is the ARN of the associated repository.
", "DescribeCodeReviewRequest$CodeReviewArn": "The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories.
The Amazon Resource Name (ARN) of the RepositoryAssociation object.
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories.
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories.
The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) of the CodeReview object.
The Amazon Resource Name (ARN) identifying the repository association.
", - "RepositoryAssociationSummary$AssociationArn": "The Amazon Resource Name (ARN) of the RepositoryAssociation object.
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories.
The repository association ID.
" } }, + "BranchName": { + "base": null, + "refs": { + "RepositoryHeadSourceCodeType$BranchName": " The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies the tip of this branch.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
To add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.
If you use the AWS CLI or one of the AWS SDKs to call this operation, you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, you must generate a ClientRequestToken yourself for new versions and include that value in the request.
You typically interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
" + "AssociateRepositoryRequest$ClientRequestToken": "Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
", + "CreateCodeReviewRequest$ClientRequestToken": "Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
" } }, "CodeCommitRepository": { @@ -68,9 +77,16 @@ "CodeReview": { "base": "Information about a code review.
", "refs": { + "CreateCodeReviewResponse$CodeReview": null, "DescribeCodeReviewResponse$CodeReview": "Information about the code review.
" } }, + "CodeReviewName": { + "base": null, + "refs": { + "CreateCodeReviewRequest$Name": "The name of the code review. Each code review of the same code review type must have a unique name in your AWS account.
" + } + }, "CodeReviewSummaries": { "base": null, "refs": { @@ -83,17 +99,23 @@ "CodeReviewSummaries$member": null } }, + "CodeReviewType": { + "base": "The type of a code review. There are two code review types:
PullRequest - A code review that is automatically triggered by a pull request on an assocaited repository. Because this type of code review is automatically generated, you cannot specify this code review type using CreateCodeReview .
RepositoryAnalysis - A code review that analyzes all code under a specified branch in an associated respository. The assocated repository is specified using its ARN in CreateCodeReview .
The type of code review to create. This is specified using a CodeReviewType object.
The commit diff for the pull request.
", + "base": " A type of SourceCodeType that specifies the commit diff for a pull request on an associated repository.
The commit diff for the pull request.
" + "SourceCodeType$CommitDiff": " A SourceCodeType that specifies a commit diff created by a pull request on an associated repository.
The SHA of the source commit.
", - "CommitDiffSourceCodeType$DestinationCommit": "The SHA of the destination commit.
" + "CommitDiffSourceCodeType$SourceCommit": "The SHA of the source commit used to generate a commit diff.
", + "CommitDiffSourceCodeType$DestinationCommit": "The SHA of the destination commit used to generate a commit diff.
" } }, "ConflictException": { @@ -104,9 +126,19 @@ "ConnectionArn": { "base": null, "refs": { - "RepositoryAssociation$ConnectionArn": " 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.
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.
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.
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.
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.
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.
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 or Bitbucket repository, this is the username for the account that owns the repository.
", - "CodeReviewSummary$Owner": "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 or Bitbucket repository, this is the username for the account that owns the repository.
", + "CodeReview$Owner": "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.
", + "CodeReviewSummary$Owner": "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.
", "Owners$member": null, - "RepositoryAssociation$Owner": "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 or Bitbucket repository, this is the username for the account that owns the repository.
", - "RepositoryAssociationSummary$Owner": "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 or Bitbucket repository, this is the username for the account that owns the repository.
", + "RepositoryAssociation$Owner": "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.
", + "RepositoryAssociationSummary$Owner": "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.
", "ThirdPartySourceRepository$Owner": "The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.
" } }, "Owners": { "base": null, "refs": { - "ListRepositoryAssociationsRequest$Owners": "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, this is name of the account that was used to associate the repository.
" + "ListRepositoryAssociationsRequest$Owners": "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.
" } }, "ProviderType": { @@ -430,6 +462,12 @@ "AssociateRepositoryRequest$Repository": "The repository to associate.
" } }, + "RepositoryAnalysis": { + "base": " A code review type that analyzes all code under a specified branch in an associated respository. The assocated repository is specified using its ARN when you call CreateCodeReview .
A code review that analyzes all code under a specified branch in an associated respository. The assocated repository is specified using its ARN in CreateCodeReview
Information about a repository association. The DescribeRepositoryAssociation operation returns a RepositoryAssociation object.
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 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.
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.
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 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.
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.
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 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.
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.
A SourceCodeType that specifies the tip of a branch in an associated repository.
A SourceCodeType that specifies the tip of a branch in an associated repository.
Information about the source code type.
", + "base": "Specifies the source code that is analyzed in a code review. A code review can analyze the source code that is specified using a pull request diff or a branch in an associated repository.
", "refs": { "CodeReview$SourceCodeType": "The type of the source code for the code review.
" } diff --git a/aws-sdk-core/apis/securityhub/2018-10-26/api-2.json b/aws-sdk-core/apis/securityhub/2018-10-26/api-2.json index 4ab24bf57ed..657ca59040f 100644 --- a/aws-sdk-core/apis/securityhub/2018-10-26/api-2.json +++ b/aws-sdk-core/apis/securityhub/2018-10-26/api-2.json @@ -1883,7 +1883,8 @@ "RecordState":{"shape":"RecordState"}, "RelatedFindings":{"shape":"RelatedFindingList"}, "Note":{"shape":"Note"}, - "Vulnerabilities":{"shape":"VulnerabilityList"} + "Vulnerabilities":{"shape":"VulnerabilityList"}, + "PatchSummary":{"shape":"PatchSummary"} } }, "AwsSecurityFindingFilters":{ @@ -3084,6 +3085,23 @@ "aws-us-gov" ] }, + "PatchSummary":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{"shape":"NonEmptyString"}, + "InstalledCount":{"shape":"Integer"}, + "MissingCount":{"shape":"Integer"}, + "FailedCount":{"shape":"Integer"}, + "InstalledOtherCount":{"shape":"Integer"}, + "InstalledRejectedCount":{"shape":"Integer"}, + "InstalledPendingReboot":{"shape":"Integer"}, + "OperationStartTime":{"shape":"NonEmptyString"}, + "OperationEndTime":{"shape":"NonEmptyString"}, + "RebootOption":{"shape":"NonEmptyString"}, + "Operation":{"shape":"NonEmptyString"} + } + }, "PortRange":{ "type":"structure", "members":{ diff --git a/aws-sdk-core/apis/securityhub/2018-10-26/docs-2.json b/aws-sdk-core/apis/securityhub/2018-10-26/docs-2.json index fd54de0f346..826011a9c15 100644 --- a/aws-sdk-core/apis/securityhub/2018-10-26/docs-2.json +++ b/aws-sdk-core/apis/securityhub/2018-10-26/docs-2.json @@ -1521,6 +1521,12 @@ "InsightResultValue$Count": "The number of findings returned for each GroupByAttributeValue.
The source port of network-related information about a finding.
", "Network$DestinationPort": "The destination port of network-related information about a finding.
", + "PatchSummary$InstalledCount": "The number of patches from the compliance standard that were installed successfully.
", + "PatchSummary$MissingCount": "The number of patches that are part of the compliance standard but are not installed. The count includes patches that failed to install.
", + "PatchSummary$FailedCount": "The number of patches from the compliance standard that failed to install.
", + "PatchSummary$InstalledOtherCount": "The number of installed patches that are not part of the compliance standard.
", + "PatchSummary$InstalledRejectedCount": "The number of patches that are installed but are also on a list of patches that the customer rejected.
", + "PatchSummary$InstalledPendingReboot": "The number of patches that were installed since the last time the instance was rebooted.
", "PortRange$Begin": "The first port in the port range.
", "PortRange$End": "The last port in the port range.
", "ProcessDetails$Pid": "The process ID.
", @@ -2241,6 +2247,11 @@ "Note$UpdatedAt": "The timestamp of when the note was updated.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
The updated note text.
", "NoteUpdate$UpdatedBy": "The principal that updated the note.
", + "PatchSummary$Id": "The identifier of the compliance standard that was used to determine the patch compliance status.
", + "PatchSummary$OperationStartTime": "Indicates when the operation started.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
Indicates when the operation completed.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
The reboot option specified for the instance.
", + "PatchSummary$Operation": "The type of patch operation performed. For Patch Manager, the values are SCAN and INSTALL.
The name of the process.
", "ProcessDetails$Path": "The path to the process executable.
", "ProcessDetails$LaunchedAt": "Indicates when the process was launched.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
The canonical AWS partition name that the Region is assigned to.
" } }, + "PatchSummary": { + "base": "Provides an overview of the patch compliance status for an instance against a selected compliance standard.
", + "refs": { + "AwsSecurityFinding$PatchSummary": "Provides an overview of the patch compliance status for an instance against a selected compliance standard.
" + } + }, "PortRange": { "base": "A range of ports.
", "refs": {