Skip to content

aws.codeguru_reviewer.describe_repository_association

Example SQL Queries

SELECT * FROM
aws.codeguru_reviewer.describe_repository_association
WHERE
"association_arn" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
association_arn Required Input Column

The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
repository_association

Information about the repository association.

STRUCT(
"association_id" VARCHAR,
"association_arn" VARCHAR,
"connection_arn" VARCHAR,
"name" VARCHAR,
"owner" VARCHAR,
"provider_type" VARCHAR,
"state" VARCHAR,
"state_reason" VARCHAR,
"last_updated_time_stamp" TIMESTAMP_S,
"created_time_stamp" TIMESTAMP_S,
"kms_key_details" STRUCT(
"kms_key_id" VARCHAR,
"encryption_option" VARCHAR
),
"s3_repository_details" STRUCT(
"bucket_name" VARCHAR,
"code_artifacts" STRUCT(
"source_code_artifacts_object_key" VARCHAR,
"build_artifacts_object_key" VARCHAR
)
)
)
Show child fields
repository_association.association_arn

The Amazon Resource Name (ARN) identifying the repository association.

repository_association.association_id

The ID of the repository association.

repository_association.connection_arn

The Amazon Resource Name (ARN) of an Amazon Web Services 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 Amazon Web Services CodeStar Connections API Reference.

repository_association.created_time_stamp

The time, in milliseconds since the epoch, when the repository association was created.

repository_association.kms_key_details

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.

Show child fields
repository_association.kms_key_details.encryption_option

The encryption option for a repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).

repository_association.kms_key_details.kms_key_id

The ID of the Amazon Web Services KMS key that is associated with a repository association.

repository_association.last_updated_time_stamp

The time, in milliseconds since the epoch, when the repository association was last updated.

repository_association.name

The name of the repository.

repository_association.owner

The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services 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. For an S3 repository, it can be the username or Amazon Web Services account ID.

repository_association.provider_type

The provider type of the repository association.

repository_association.s3_repository_details

Specifies the name of an S3 bucket and a CodeArtifacts object that contains the S3 object keys for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.

Show child fields
repository_association.s3_repository_details.bucket_name

The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-.

repository_association.s3_repository_details.code_artifacts

A CodeArtifacts object. The CodeArtifacts object includes the S3 object key for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.

Show child fields
repository_association.s3_repository_details.code_artifacts.build_artifacts_object_key

The S3 object key for a build artifacts .zip file that contains .jar or .class files. This is required for a code review with security analysis. For more information, see Create code reviews with GitHub Actions in the Amazon CodeGuru Reviewer User Guide.

repository_association.s3_repository_details.code_artifacts.source_code_artifacts_object_key

The S3 object key for a source code .zip file. This is required for all code reviews.

repository_association.state

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.

  • 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.

repository_association.state_reason

A description of why the repository association is in the current state.

tags

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.

MAP(VARCHAR, VARCHAR)