Struct aws_sdk_codegurureviewer::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Client for Amazon CodeGuru Reviewer

Client for invoking operations on Amazon CodeGuru Reviewer. Each operation on Amazon CodeGuru Reviewer is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_codegurureviewer::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_codegurureviewer::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_codegurureviewer::Client::from_conf(config);

Implementations§

source §

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source §

impl Client

source

pub fn associate_repository(&self) -> AssociateRepository

Constructs a fluent builder for the AssociateRepository operation.

The fluent builder is configurable:
- repository(Repository) / set_repository(Option<Repository>):
 The repository to associate.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 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.
- kms_key_details(KmsKeyDetails) / set_kms_key_details(Option<KmsKeyDetails>):
 A KMSKeyDetails object that contains:
 - The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).
 - The ID of the Amazon Web Services KMS key that is associated with this repository association.
On success, responds with AssociateRepositoryOutput with field(s):
- repository_association(Option<RepositoryAssociation>):
 Information about the repository association.
- tags(Option<HashMap<String, String>>):
 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.
On failure, responds with SdkError<AssociateRepositoryError>

source

pub fn create_code_review(&self) -> CreateCodeReview

Constructs a fluent builder for the CreateCodeReview operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the code review. The name of each code review in your Amazon Web Services account must be unique.
- repository_association_arn(impl Into<String>) / set_repository_association_arn(Option<String>):
 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.
- r#type(CodeReviewType) / set_type(Option<CodeReviewType>):
 The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of type RepositoryAnalysis.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
On success, responds with CreateCodeReviewOutput with field(s):
- code_review(Option<CodeReview>):
 Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
On failure, responds with SdkError<CreateCodeReviewError>

source

pub fn describe_code_review(&self) -> DescribeCodeReview

Constructs a fluent builder for the DescribeCodeReview operation.

The fluent builder is configurable:
- code_review_arn(impl Into<String>) / set_code_review_arn(Option<String>):
 The Amazon Resource Name (ARN) of the CodeReview object.
On success, responds with DescribeCodeReviewOutput with field(s):
- code_review(Option<CodeReview>):
 Information about the code review.
On failure, responds with SdkError<DescribeCodeReviewError>

source

pub fn describe_recommendation_feedback(&self) -> DescribeRecommendationFeedback

Constructs a fluent builder for the DescribeRecommendationFeedback operation.

The fluent builder is configurable:
- code_review_arn(impl Into<String>) / set_code_review_arn(Option<String>):
 The Amazon Resource Name (ARN) of the CodeReview object.
- recommendation_id(impl Into<String>) / set_recommendation_id(Option<String>):
 The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
- user_id(impl Into<String>) / set_user_id(Option<String>):
 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 Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the Amazon Web Services Identity and Access Management User Guide.
On success, responds with DescribeRecommendationFeedbackOutput with field(s):
- recommendation_feedback(Option<RecommendationFeedback>):
 The recommendation feedback given by the user.
On failure, responds with SdkError<DescribeRecommendationFeedbackError>

source

pub fn describe_repository_association(&self) -> DescribeRepositoryAssociation

Constructs a fluent builder for the DescribeRepositoryAssociation operation.

The fluent builder is configurable:
- association_arn(impl Into<String>) / set_association_arn(Option<String>):
 The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
On success, responds with DescribeRepositoryAssociationOutput with field(s):
- repository_association(Option<RepositoryAssociation>):
 Information about the repository association.
- tags(Option<HashMap<String, String>>):
 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.
On failure, responds with SdkError<DescribeRepositoryAssociationError>

source

pub fn disassociate_repository(&self) -> DisassociateRepository

Constructs a fluent builder for the DisassociateRepository operation.

The fluent builder is configurable:
- association_arn(impl Into<String>) / set_association_arn(Option<String>):
 The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
On success, responds with DisassociateRepositoryOutput with field(s):
- repository_association(Option<RepositoryAssociation>):
 Information about the disassociated repository.
- tags(Option<HashMap<String, String>>):
 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.
On failure, responds with SdkError<DisassociateRepositoryError>

source

pub fn list_code_reviews(&self) -> ListCodeReviews

Constructs a fluent builder for the ListCodeReviews operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- provider_types(Vec<ProviderType>) / set_provider_types(Option<Vec<ProviderType>>):
 List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.
- states(Vec<JobState>) / set_states(Option<Vec<JobState>>):
 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.
- repository_names(Vec<String>) / set_repository_names(Option<Vec<String>>):
 List of repository names for filtering that needs to be applied before displaying the result.
- r#type(Type) / set_type(Option<Type>):
 The type of code reviews to list in the response.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results that are returned per call. The default is 100.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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.
On success, responds with ListCodeReviewsOutput with field(s):
- code_review_summaries(Option<Vec<CodeReviewSummary>>):
 A list of code reviews that meet the criteria of the request.
- next_token(Option<String>):
 Pagination token.
On failure, responds with SdkError<ListCodeReviewsError>

source

pub fn list_recommendation_feedback(&self) -> ListRecommendationFeedback

Constructs a fluent builder for the ListRecommendationFeedback operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results that are returned per call. The default is 100.
- code_review_arn(impl Into<String>) / set_code_review_arn(Option<String>):
 The Amazon Resource Name (ARN) of the CodeReview object.
- user_ids(Vec<String>) / set_user_ids(Option<Vec<String>>):
 An Amazon Web Services 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 Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the Amazon Web Services Identity and Access Management User Guide.
- recommendation_ids(Vec<String>) / set_recommendation_ids(Option<Vec<String>>):
 Used to query the recommendation feedback for a given recommendation.
On success, responds with ListRecommendationFeedbackOutput with field(s):
- recommendation_feedback_summaries(Option<Vec<RecommendationFeedbackSummary>>):
 Recommendation feedback summaries corresponding to the code review ARN.
- next_token(Option<String>):
 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.
On failure, responds with SdkError<ListRecommendationFeedbackError>

source

pub fn list_recommendations(&self) -> ListRecommendations

Constructs a fluent builder for the ListRecommendations operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 Pagination token.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results that are returned per call. The default is 100.
- code_review_arn(impl Into<String>) / set_code_review_arn(Option<String>):
 The Amazon Resource Name (ARN) of the CodeReview object.
On success, responds with ListRecommendationsOutput with field(s):
- recommendation_summaries(Option<Vec<RecommendationSummary>>):
 List of recommendations for the requested code review.
- next_token(Option<String>):
 Pagination token.
On failure, responds with SdkError<ListRecommendationsError>

source

pub fn list_repository_associations(&self) -> ListRepositoryAssociations

Constructs a fluent builder for the ListRepositoryAssociations operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- provider_types(Vec<ProviderType>) / set_provider_types(Option<Vec<ProviderType>>):
 List of provider types to use as a filter.
- states(Vec<RepositoryAssociationState>) / set_states(Option<Vec<RepositoryAssociationState>>):
 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 anassociated 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.
- names(Vec<String>) / set_names(Option<Vec<String>>):
 List of repository names to use as a filter.
- owners(Vec<String>) / set_owners(Option<Vec<String>>):
 List of owners to use as a filter. For Amazon Web Services 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.
- max_results(i32) / set_max_results(Option<i32>):
 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.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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.
On success, responds with ListRepositoryAssociationsOutput with field(s):
- repository_association_summaries(Option<Vec<RepositoryAssociationSummary>>):
 A list of repository associations that meet the criteria of the request.
- next_token(Option<String>):
 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.
On failure, responds with SdkError<ListRepositoryAssociationsError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, String>>):
 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.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn put_recommendation_feedback(&self) -> PutRecommendationFeedback

Constructs a fluent builder for the PutRecommendationFeedback operation.

The fluent builder is configurable:
- code_review_arn(impl Into<String>) / set_code_review_arn(Option<String>):
 The Amazon Resource Name (ARN) of the CodeReview object.
- recommendation_id(impl Into<String>) / set_recommendation_id(Option<String>):
 The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
- reactions(Vec<Reaction>) / set_reactions(Option<Vec<Reaction>>):
 List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.
On success, responds with PutRecommendationFeedbackOutput
On failure, responds with SdkError<PutRecommendationFeedbackError>

source

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 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.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>

source

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
 A list of the keys for each tag you want to remove from an associated repository.
On success, responds with UntagResourceOutput
On failure, responds with SdkError<UntagResourceError>

source §

impl Client

source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.