amazonka-codeguru-reviewer-2.0: Amazon CodeGuru Reviewer SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Description

Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by ProviderType, Name, State, and Owner.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRepositoryAssociations Source #

See: newListRepositoryAssociations smart constructor.

Constructors

ListRepositoryAssociations' 

Fields

  • maxResults :: Maybe Natural

    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.

  • names :: Maybe (NonEmpty Text)

    List of repository names to use as a filter.

  • nextToken :: Maybe Text

    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.

  • owners :: Maybe (NonEmpty Text)

    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.

  • providerTypes :: Maybe (NonEmpty ProviderType)

    List of provider types to use as a filter.

  • states :: Maybe (NonEmpty 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.

Instances

Instances details
ToHeaders ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

ToPath ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

ToQuery ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

AWSPager ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

AWSRequest ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Generic ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Associated Types

type Rep ListRepositoryAssociations :: Type -> Type #

Read ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Show ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

NFData ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Eq ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Hashable ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

type AWSResponse ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

type Rep ListRepositoryAssociations Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

type Rep ListRepositoryAssociations = D1 ('MetaData "ListRepositoryAssociations" "Amazonka.CodeGuruReviewer.ListRepositoryAssociations" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "ListRepositoryAssociations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "owners") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "providerTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ProviderType))) :*: S1 ('MetaSel ('Just "states") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty RepositoryAssociationState)))))))

newListRepositoryAssociations :: ListRepositoryAssociations Source #

Create a value of ListRepositoryAssociations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListRepositoryAssociations', listRepositoryAssociations_maxResults - 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.

$sel:names:ListRepositoryAssociations', listRepositoryAssociations_names - List of repository names to use as a filter.

ListRepositoryAssociations, listRepositoryAssociations_nextToken - 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.

$sel:owners:ListRepositoryAssociations', listRepositoryAssociations_owners - 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.

$sel:providerTypes:ListRepositoryAssociations', listRepositoryAssociations_providerTypes - List of provider types to use as a filter.

$sel:states:ListRepositoryAssociations', listRepositoryAssociations_states - 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.

Request Lenses

listRepositoryAssociations_maxResults :: Lens' ListRepositoryAssociations (Maybe Natural) Source #

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.

listRepositoryAssociations_names :: Lens' ListRepositoryAssociations (Maybe (NonEmpty Text)) Source #

List of repository names to use as a filter.

listRepositoryAssociations_nextToken :: Lens' ListRepositoryAssociations (Maybe Text) Source #

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.

listRepositoryAssociations_owners :: Lens' ListRepositoryAssociations (Maybe (NonEmpty Text)) Source #

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.

listRepositoryAssociations_states :: Lens' ListRepositoryAssociations (Maybe (NonEmpty RepositoryAssociationState)) Source #

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.

Destructuring the Response

data ListRepositoryAssociationsResponse Source #

Constructors

ListRepositoryAssociationsResponse' 

Fields

  • nextToken :: Maybe Text

    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.

  • repositoryAssociationSummaries :: Maybe [RepositoryAssociationSummary]

    A list of repository associations that meet the criteria of the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListRepositoryAssociationsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Associated Types

type Rep ListRepositoryAssociationsResponse :: Type -> Type #

Read ListRepositoryAssociationsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Show ListRepositoryAssociationsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

NFData ListRepositoryAssociationsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

Eq ListRepositoryAssociationsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

type Rep ListRepositoryAssociationsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.ListRepositoryAssociations

type Rep ListRepositoryAssociationsResponse = D1 ('MetaData "ListRepositoryAssociationsResponse" "Amazonka.CodeGuruReviewer.ListRepositoryAssociations" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "ListRepositoryAssociationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "repositoryAssociationSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RepositoryAssociationSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRepositoryAssociationsResponse Source #

Create a value of ListRepositoryAssociationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListRepositoryAssociations, listRepositoryAssociationsResponse_nextToken - 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.

$sel:repositoryAssociationSummaries:ListRepositoryAssociationsResponse', listRepositoryAssociationsResponse_repositoryAssociationSummaries - A list of repository associations that meet the criteria of the request.

$sel:httpStatus:ListRepositoryAssociationsResponse', listRepositoryAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

listRepositoryAssociationsResponse_nextToken :: Lens' ListRepositoryAssociationsResponse (Maybe Text) Source #

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.